Hoppa till innehåll
Firmainfo Docs API v1 för svenska företagsdata
API-referens OpenAPI Driftstatus
Meny och API-referens

Guide

Felhantering

Alla fel har samma struktur och stabila felkoder som klienten kan hantera.

Varje misslyckat anrop returnerar samma grundstruktur. Det gör att en gemensam felhanterare räcker för hela API:et.

json 
{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "One or more request parameters are invalid.",
    "param": null,
    "request_id": "req_9f3a1c0d2b4e6a8c1d3f",
    "errors": [
      { "param": "limit", "message": "must be an integer 1-100" }
    ]
  }
}
  • type anger den övergripande felkategorin.
  • code är den stabila maskinkoden som klientlogiken ska använda.
  • message ger en kort förklaring på engelska och återger aldrig känslig indata.
  • param pekar ut parametern när felet gäller ett särskilt fält.
  • request_id motsvarar svarets X-Request-Id. Skicka med värdet när du kontaktar supporten.

Felkoder

HTTPKodVad du behöver göra
401invalid_api_keyKontrollera att rätt aktiv nyckel skickas som Bearer-token
403missing_scopeBegär rätt scope eller använd en resurs som nyckeln får läsa
403terms_acceptance_requiredAcceptera den senaste versionen av datavillkoren
403not_in_planByt plan eller be om att funktionen läggs till i avtalet
404not_foundKontrollera identifieraren eller hantera posten som saknad
400invalid_requestRätta förfrågan innan den skickas igen
400invalid_cursorStarta om listningen från första sidan
400cursor_conflictÅtergå till filtren från första sidan eller starta en ny listning
410cursor_expiredStarta om eftersom sidmarkören har gått ut
422validation_errorRätta fältet som anges i error.errors
429rate_limitedVänta den tid som anges i Retry-After
429monthly_quota_exceededPausa till nästa månad eller höj kvoten
503query_timeoutGör urvalet smalare och försök igen
503service_unavailableFörsök igen med backoff efter den angivna väntetiden
500internal_errorLogga request_id och kontakta oss om felet återkommer

Okända parametrar avvisas

Om ett filter är felstavat svarar API:et med 422. Exempelvis avvisas ?min_revenu=5 direkt. Du riskerar därför inte att ett felaktigt filter råkar returnera ett stort urval.

404 och okända identifierare

Felformade, okända och otillåtna identifierare ger samma 404-svar. API:et återger inte värdet du skickade in. Det gör att svaret inte kan användas för att kontrollera om en viss person förekommer i registret.