Allt som konsolen gör går genom samma API som du kan anropa från din egen kod. Varje route ligger under /v1, och du kan prova varje endpoint från dess sida i API-referensen med knappen Prova, inloggad eller med en API-nyckel.
Dina egna system använder en API-nyckel. Du väljer läge (live för skarpa laddstationer, sandbox bara för testdata och virtuella laddstationer), räckvidd (ett projekt eller alla projekt i organisationen) och ett valfritt utgångsdatum. En nyckel kan aldrig ha policyn Owner, och när du återkallar en nyckel gäller det vid nästa anrop. Personer använder sin inloggning, som API:et kontrollerar med ett bevis knutet till en nyckel som bara deras webbläsare håller.
Inom /v1 läggs bara saker till: nya fält, endpoints, felkoder och enumvärden. Det som ska försvinna markeras först som utfasat och finns kvar i minst sex månader, med besked i referensen, i API-dokumentet och i rubrikerna Deprecation och Sunset på varje svar. Listor bläddras med nextCursor, och kommandon till laddstationer går genom en endpoint som köar medan laddstationen är offline och kan skickas om säkert med en Idempotency-Key.
Bra att veta
- Läs svar toleranskt: ett nytt fält, en ny felkod, ett nytt enumvärde eller en ny variant kan dyka upp inom /v1 utan förvarning.
- Alla routes under /v1 delar en förfrågningsbudget per IP-adress; varje svar visar var du står, och budgeten beskrivs utan siffra i guiden om begränsningar.
- En API-nyckel kan aldrig ha policyn Owner och har exakt en policykoppling.
- En sandbox-nyckel når bara sandbox-data och en live-nyckel bara live-data.