Utvecklare (API)

Förutom appen erbjuder ANABOX smart också en API med vilken utvecklare kan integrera individuella applikationer eller befintliga system.

Komma igång

För att använda API:et måste du:

• Använda en giltig API-nyckel för att skicka förfrågningar till API-slutpunkterna.
  Du får din API-nyckel i paperlesspaper-applikationen.
• Endast HTTPS-anslutningar är tillåtna. Förfrågningar över HTTP omdirigeras till HTTPS via HTTP 301-omdirigering.
• API:et returnerar svar i JSON-format. Fel visas i JSON-kroppen under nyckeln error.

Hur skapar jag tokens?

Du kan generera API-nycklar i dina användarinställningar.

Var hittar jag dokumentationen för API:et?

Du hittar dokumentationen här.

Autentisering

API:et använder två autentiseringsmetoder:
Egna API-tokens och Auth0 JWT-tokens.

API-token-autentisering

Du kan generera en anpassad API-token i paperlesspaper-appen eller via din administratör.
För autentisering, lägg till API-token i Authorization-headern som en Bearer-token:

Authorization: Bearer <ditt-token>

• API-token måste vara ett 64-siffrigt hexadecimalt värde.
• Om token är giltigt kommer förfrågan att autentiseras i den associerade användarens namn.

Felmeddelanden för autentisering

• 401 Obehörig: Token saknas, är ogiltigt eller har gått ut.
• 403 Förbjuden: Autentiserad, men ingen behörighet för slutpunkten.

Hastighets- och användningsbegränsningar

Åtkomstbegränsningarna gäller per API-nyckel och tidsenhet.
Gränsen är 300 förfrågningar per minut.
Ytterligare användningsbegränsningar kan gälla beroende på plan.
Vid överskridande får du HTTP-status 429 För många förfrågningar.

HTTP 503 Svar

Ett HTTP-503-fel indikerar en oväntad toppbelastning i API-åtkomst.
Servern är vanligtvis tillgänglig igen inom fem minuter.
Vid fortsatt störning eller andra HTTP 5XX-fel, vänligen kontakta supporten.