Feil

Problemdokumentet hver feil gir, og hva hver feilkode betyr.

Oversikt⁠

En feil svarer med den passende HTTP-statusen og et problemdokument etter RFC 9457. Innholdstypen er application/problem+json.

curl -i https://attia.app/api/v1/jobs \  -H "Authorization: Bearer attia_api_not_a_real_key"

{  "type": "https://attia.app/docs/api-errors#invalid-api-key",  "title": "Invalid API key",  "status": 401,  "detail": "The request has no API key, or the key is unknown, revoked or expired.",  "code": "invalid-api-key"}

Problemdokumentet⁠

Felt	Type	Betydning
`type`	URL	En lenke til kodens avsnitt på denne siden
`title`	streng	Et kort sammendrag for mennesker
`status`	heltall	HTTP-statusen
`detail`	streng	Hva som gikk galt, for mennesker. Utelatt ved `internal-error`
`code`	streng	Feilens faste navn
`errors`	liste	Bare ved `invalid-request`: én oppføring per parameter, med `field` og `message`

Bruk code i koden din. Den endrer seg aldri. title og detail er skrevet for mennesker, alltid på engelsk, og kan få ny ordlyd.

Koder⁠

invalid-api-key⁠

Status 401. Forespørselen mangler nøkkel, nøkkelen er feilskrevet, eller den er ukjent, tilbakekalt eller utløpt. Svaret har headeren WWW-Authenticate: Bearer. Opprett en ny nøkkel og send den i Authorization-headeren. Se Autentisering.

browser-not-allowed⁠

Status 403. Forespørselen kom fra en nettleser: den hadde en Origin-header eller Sec-Fetch-Mode: cors. API-et avviser den før det leser nøkkelen. Kall API-et fra en server og hold nøkkelen der. Se Autentisering.

insufficient-scope⁠

Status 403. Nøkkelen er gyldig, men mangler tillatelsen operasjonen krever. Lesing krever Lese. Opprett en nøkkel som har den.

plan-required⁠

Status 403. API-et er tilgjengelig på Business- og Enterprise-planene, og nøkkelens arbeidsområde er på Free eller Basic. Etter en nedgradering beholder arbeidsområdet nøklene sine, og hvert kall svarer med denne koden. Oppgrader til Business, så virker de samme nøklene igjen.

ip-not-allowed⁠

Status 403. Arbeidsområdet begrenser tilgang etter IP-adresse, og kallet kom fra en adresse utenfor listen. Kall fra en adresse på listen, eller be en administrator i arbeidsområdet om å legge til din.

invalid-request⁠

Status 400. En spørreparameter er ukjent, gjentatt eller har en verdi API-et ikke godtar. errors navngir hver av dem.

curl -i "https://attia.app/api/v1/jobs?limit=ten" \  -H "Authorization: Bearer $ATTIA_API_KEY"

{  "type": "https://attia.app/docs/api-errors#invalid-request",  "title": "Invalid request",  "status": 400,  "detail": "One or more parameters are not valid.",  "code": "invalid-request",  "errors": [{ "field": "limit", "message": "Must be an integer from 1 to 100." }]}

not-found⁠

Status 404. Ingen operasjon finnes på stien du kalte, eller stien peker på en oppføring nøkkelen din ikke kan se. En oppføring som ikke finnes, får det samme svaret som en nøkkelen ikke kan se. Stien må stemme nøyaktig, så en skråstrek til slutt eller en stor bokstav gir en annen sti. Sjekk metoden, stien og id-en mot denne dokumentasjonen.

rate-limited⁠

Status 429. Du har sendt for mange forespørsler. Vent så mange sekunder som Retry-After-headeren sier, og prøv igjen. Se Rategrenser.

api-unavailable⁠

Status 503. API-et er slått av eller kan ikke nås akkurat nå. Prøv igjen senere.

internal-error⁠

Status 500. Noe feilet hos oss, og vi har fått en rapport om det. Det kan hjelpe å prøve igjen. Hvis feilen fortsetter, kontakt support.