Aloitus

Virheet

Kun jokin menee pieleen, API palauttaa vastaavan HTTP-tilakoodin ja rungon, jonka objektissa error ovat kentät code ja message.

Käytä ohjelmassasi kenttää code. Kenttä message on englanninkielinen teksti, joka auttaa vianetsinnässä, ja se voi muuttua.

Virheen muoto404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

Ei avainta401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Virhekoodit

Tila	Koodi	Milloin esiintyy
400	`key_in_query`	Avain lähetettiin osoitteessa (parametri `api_key`, `apikey`, `key` tai `token`). Lähetä se otsakkeessa ja luo uusi avain, koska edellinen on voinut tallentua lokeihin.
400	`invalid_parameter`	Parametrilla on virheellinen arvo, esimerkiksi `per_page` on suurempi kuin enimmäisarvo.
401	`missing_api_key`	Pyynnössä ei ollut avainta.
401	`invalid_api_key`	Avainta ei ole olemassa, se on mitätöity tai sen käyttäjä on poistettu käytöstä.
404	`not_found`	Päätepistettä ei ole olemassa, tai kohdetta ei ole olemassa tai se kuuluu organisaatiolle, jota käyttäjä ei näe.
404	`organization_not_found`	Annettu `organization` ei ole organisaatio, jossa käyttäjä voi nähdä tämäntyyppisiä kohteita.
405	`method_not_allowed`	API hyväksyy vain metodin `GET` (sekä `HEAD`).
429	`rate_limited`	Pyyntöraja on saavutettu. Odota otsakkeen `Retry-After` ilmoittama määrä sekunteja.
500	`server_error`	Sisäinen virhe. Yritä hetken kuluttua uudelleen; jos virhe toistuu, ota yhteyttä tukeen.

Milloin yrittää uudelleen

Saman pyynnön toistaminen kannattaa vain virheen 429 jälkeen (kun olet odottanut otsakkeen Retry-After ajan) tai virheen 500 jälkeen. Muut virheet vaativat korjausta pyyntöön tai avaimeen.