Alla Trafiklabs APIer kräver en giltig API-nyckel för att man ska kunna använda dem. Att få en nyckel är helt kostnadsfritt och allt man behöver göra är att registrera sig på Trafiklab och begära en nyckel för det API man vill använda. En API nyckel är unikt för ett API och ett projekt, dvs det går inte att använda en API nyckel för Resrobot APIet för SL Trafikläget APIet. 

För att få en API-nyckel så måste man godkänna och följa de gällande licensvillkoren. 

Vad är en API-nyckel?

En API-nyckel är helt enkelt en unik sträng som skickas med varje API-anrop för att identifiera vem det är som använder APIet. För att få en API-nyckel så måste man godkänna APIets licensvillkor och man binder sig att följa dessa villkor när man använder APIet. En API-nyckel ska man inte dela med sig av utan hålla privat, annars så kan någon annan missbruka ett API i ditt namn.

Skapa en API-nyckel

Med några enkla steg kan du få en API-nyckel till det API du vill använda...

1. Skapa ett projekt

Gå till Skapa ett nytt projekt (du måste vara inloggad för detta) och välj vilka APIer som du vill använda i ditt nya projekt. Det är de APIer du väljer här som du senare kan skapa API nycklar för.

2. Ansök om API nycklar

När ditt nya projekt är skapat så visas projektets sida. Högs upp på sidan så finns "Mina API nycklar", klicka där för att expandera. Här listas alla projektets APIer och efter varje API finns en "Hämta nyckel" knapp. Klicka här för att hämta en API nyckel för just det APIet. Innan en nyckel skapas så måste du godkänna APIets licensvillkor.

3. Hitta dina API nycklar

API nycklar för ett projekt listas alltid i "Mina API nycklar" delen på projektsidan. Du kan också få en lista över alla dina API nycklar från alla projekt om du går till "Mitt konto". Alla dina nycklar för ett givet API listas också i APIets dokumentation.

Använd en API-nyckel

En API-nyckel skickas med i ett API-anrop via key-parametern. Om inte en giltig API nyckel för APIet som används skickas med så kommer ett fel att returneras.

Exempel

För att anropa ResRobot APIets Platsuppslag (en metod) så skickas API nyckeln ABC123 med enligt följande anrop:

https://api.resrobot.se/location.name.xml?key=ABC123&input=Centralen

Begränsningar

I enlighet med licensvillkoren finns tekniska begränsningar för APIerna i form av

  • Antal anrop per månad (anropsräkning startas från noll vid månadens början, överskrids antalet anrop under månaden tillåts inga fler anrop)
  • Antal anrop per minut

Dessa begränsningar finns för att undvika driftstörningar i underliggande system till följd av oväntad hög belastning. För exakta begränsningar, se varje APIs individuella sida.

API-nycklar till ett visst API kan ha tre olika tillgänglighetsnivåer – brons, silver och guld. Vissa APIer har endast en nivå. Vid begäran om tillgång till ett API ges per automatik tillgång till nivå brons. Om du önskar högre nivåer vad gäller ovanstående begränsningar kan du ansöka om silver eller guldnivån.

//fixa text// För att ansöka om silver och guldnivån behöver du skicka ett e-brev till konto@trafiklab.se där du anger din API-nyckel, användarnamn, kontaktuppgifter samt vilket API som avses. För att kunna bedöma din ansökan behöver du ha en utförlig presentation av din tjänst eller projekt på Trafiklab.se. När vi får din ansökan kontrolleras att din tjänst ligger i linje med licensvillkoren. //slut fixa text//

Vid behov tar vi också kontakt med dig för förtydliganden.

Felmeddelande

Om man gör fler anrop till ett API än vad som är tillåtet så får man tillbaka ett felmeddelande med HTTP status koden "403 Forbidden".