API-dokumentasie

Integreer ABRP se kragtige EV-roetebeplanning en -beplanning in jou platform. Ons omvattende API-stel maak naatlose integrasie van voertuigbewuste roetebeplanning, telemetrie en diep skakeling moontlik.

API's en integrasie

Kry toegang tot ons API-stel om EV-roetebeplanning, telemetrie en diep skakeling in jou platform te integreer.

Planning API

v2 - Aanbeveel

v1 - Verouderd

Voertuigbewuste roetebeplanning met omvattende EV-beplanning

Ons Planning API bied gesofistikeerde roetebeplanning wat saam met ABRP se deurlopende verbeterings groei. Funksies sluit in modellering van energieverbruik, laai-optimalisering, intydse verkeersintegrasie en weerbewuste beplanning.

Die API gebruik 'n REST-argitektuur met JSON-afvoer en ondersteun beide verouderde (v1) en moderne (v2) eindpunte. Opstelkoste en prys per plan verskil op grond van jou integrasiebehoeftes en gebruiksvolume.

v2 Planning-dokumentasie v1 Planning-dokumentasie (verouderd)

Telemetry API

Intydse voertuigdata vir lewendige nasporing en voertuigmodellering

Die Telemetry API maak intydse versending van voertuigdata moontlik vir lewendige reisnasporing, verbruiksanalise en deurlopende verbetering van ons voertuigmodelle. Dit help ons om energievoorspellings en roetebeplanning-akkuraatheid te verfyn.

Gratis API-sleutels is beskikbaar vir integrasie. Gebruikertekens word benodig om data in te dien en kan verkry word deur ons OAuth2-vloei (aanbeveel) of handmatige tekenverkryging vir toetsing en ontwikkeling.

Telemetry-dokumentasie Beheer jou telemetrie-API-sleutels

OAuth2 API

Veilige gebruikerverifiëring en magtiging

OAuth2 bied 'n veilige en gerieflike manier om gebruikers by Iternio te identifiseer en te verifieer. Om OAuth2 op te stel, het jy 'n API-sleutel nodig en moet jy 'n herleidings-URL en toepassingnaam verskaf.

Magtigingsvloei

Die eerste oproep gee 'n HTML-bladsy terug waar gebruikers kan aanmeld en jou toepassing goedkeur. As dit in die gebruiker se standaardblaaier oopgemaak word, kan hul aanmelding gekas word om die proses te vereenvoudig.

https://abetterrouteplanner.com/oauth/auth?client_id=<your_client_id>&scope=<requested_scope>&response_type=code&redirect_uri=<your_redirect_uri>

Toegelate omvange:

get_telemetry: Haal die gebruiker se jongste telemetrie
set_telemetry: Stuur nuwe telemetrie-opdaterings na die voertuig
get_plan: Kry die jongste plan in saamgeperste vorm (kontak ons vir besonderhede)
vehicle_history: Haal historiese ritte en laaisessies (kontak ons vir besonderhede)

Antwoord by jou herleidings-URI:

https://your_redirect_uri?state=<state_provided>&auth_code=<returned_auth_code>

Tekenverkryging

Sodra jy 'n magtigingskode ontvang, haal die teken wat gestoor en hergebruik kan word soos nodig.

https://api.iternio.com/1/oauth/token?client_id=<your_client_id>&client_secret=<your_api_key>&code=<auth_code>

Antwoordformaat:

{
  "access_token": "<the created token>",
  "token_type": "bearer",
  "state": "<your supplied state>"
}

Gebruikerinligting

Nadat jy die teken verkry het, gebruik die "me"-eindpunt om gebruikerinligting te haal:

https://api.iternio.com/1/oauth/me?access_token=<the user token>&api_key=<your api key>

Antwoordformaat:

{
  "user_id": <the numeric ID of the user>,
  "full_name": "<Full name of the user>",
  "email": "<Email of user>",
  "vehicle_id": <The numeric ID of the vehicle, if part of the scope>,
  "vehicle_name": "<The vehicle name>",
  "vehicle_typecode": "<The vehicle typecode>"
}

Deep Links

URL-gebaseerde integrasie vir vooraf opgestelde roetebeplanning

Skep pasgemaakte URL's wat ABRP begin met vooraf opgestelde roetes, voertuigkeuses en beplanningsparameters. Perfek om in apps, webwerwe of navigasiestelsels in te bed sonder API-integrasie.

Deep links ondersteun 'n wye reeks URL-parameters, insluitend oorsprong-/bestemmingskoördinate, roetepunte, motormodelle, batterystand en gebruikersvoorkeure. Basis-URL: https://abetterrouteplanner.com

Deep Links-dokumentasie