API-Dokumentatioun

Integréier déi mächteg EV-Routing- a Planungsfäegkeeten vun ABRP an deng Plattform. Eis ëmfaassend API-Suite erméiglecht eng nahtlos Integratioun vu gefierbewosstem Routing, Telemetrie an Deep Linking.

APIen & Integratioun

Kritt Zougang zu eiser API-Suite, fir EV-Routing, Telemetrie an Deep Linking an deng Plattform ze integréieren.

Planning API

v2 - Recommandéiert

v1 - Legacy

Gefierbewosst Routing mat ëmfaassende EV-Planungsfäegkeeten

Eis Planning API liwwert e fortgeschratte Routenplang, deen sech mat den ëmmer weidere Verbesserunge vun ABRP weiderentwéckelt. Funktiounen ëmfaasse Modelléierung vum Energieverbrauch, Luedoptiméierung, Echtzäit-Verkéiersintegratioun a wiederbewosst Planung.

D'API benotzt eng REST-Architektur mat JSON-Output an ënnerstëtzt souwuel Legacy- (v1) wéi och modern (v2) Endpunkten. Setupkäschten a Präis pro Plang variéieren no dengen Integratiounsbedierfnesser an dem Notzungsvolumen.

v2 Planning-Dokumentatioun v1 Planning-Dokumentatioun (Legacy)

Telemetry API

Echtzäit-Gefierdaten fir Live-Tracking an d'Modelléierung vun Autoen

D'Telemetry API erméiglecht d'Iwwerdroe vun Echtzäit-Gefierdaten fir Live-Rees-Tracking, Verbrauchsanalyse an déi ëmmer weider Verbesserung vun eise Modeller. Dat hëlleft eis, d'Energieprognosen an d'Genauegkeet vum Routing ze verfeineren.

Gratis API-Keys sinn fir d'Integratioun disponibel. Fir d'Verschécke vun Daten brauchs du User-Tokens; déi kriss du iwwer eise OAuth2-Flow (recommandéiert) oder manuell fir Tester an Entwécklung.

Telemetry-Dokumentatioun Deng Telemetry-API-Keys verwalten

OAuth2 API

Sécher Benotzerauthentifikatioun an Autorisatioun

OAuth2 ass eng sécher a praktesch Manéier, fir Benotzer bei Iternio z'identifizéieren an z'authentifizéieren. Fir OAuth2 anzeriichten, brauchs du en API-Key a muss eng Redirect-URL an en Applikatiounsnumm uginn.

Autorisatiounsflux

Den éischten Opruff gëtt eng HTML-Säit zréck, wou Benotzer sech aloggen an deng Applikatioun gutthee kënnen. Wann se am Standardbrowser vum Benotzer opgemaach gëtt, kann den Login gecacht ginn, fir de Prozess ze vereinfachen.

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

Erlaabt Scopes:

get_telemetry: Lescht Telemetrie vum Benotzer ofruffen
set_telemetry: Nei Telemetrie-Updaten un d'Gefier schécken
get_plan: De leschte Plang a kompakter Form ofruffen (kontaktéier eis fir Detailer)
vehicle_history: Historesch Fueren a Luedsessiounen ofruffen (kontaktéier eis fir Detailer)

Äntwert op denger Redirect-URI:

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

Token ofruffen

Soubal s du en Autorisatiounscode kriss, rufs du den Token of; deen kanns du späicheren an erëm benotzen, wann néideg.

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

Äntwertformat:

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

Benotzerinformatioun

No dem Erhale vum Token benotz den "me"-Endpunkt, fir d'Benotzerinformatioun ofzeruffen:

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

Äntwertformat:

{
  "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-baséiert Integratioun fir virkonfiguréierte Routenplang

Erstell eege URLen, déi ABRP mat virkonfiguréierte Routen, Gefierauswiel a Planungsparameter starten. Perfekt fir d'Anbetten an Apps, Websäiten oder Navigatiounssystemer ouni API-Integratioun.

Deep Links ënnerstëtzen eng breet Palette vun URL-Parameteren, dorënner Start-/Zilkoordinaten, Wegpunkten, Automodeller, Luedstand a Benotzerpreferenzen. Basis-URL: https://abetterrouteplanner.com

Deep Links-Dokumentatioun