Алғашқы қадамдар

Қателер

Бірдеңе дұрыс болмаса, API тиісті HTTP күй кодымен және error ішінде code пен message бар денемен жауап береді.

Бағдарламаңызда code мәнін пайдаланыңыз. message — жөндеу жүргізіп жатқан адамға көмектесуге арналған ағылшынша мәтін, ол өзгеруі мүмкін.

Қате форматы404

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

Кілт жоқ401

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

Қате кодтары

Күйі	Коды	Қашан пайда болады
400	`key_in_query`	Кілт URL мекенжайында жіберілді (`api_key`, `apikey`, `key` немесе `token` параметрлері). Кілтті тақырыпта жіберіңіз және жаңа кілт жасаңыз, өйткені алдыңғысы журналдарға жазылып қалған болуы мүмкін.
400	`invalid_parameter`	Параметрдің мәні жарамсыз, мысалы, `per_page` ең жоғарғы мәннен асады.
401	`missing_api_key`	Сұраныста кілт жоқ.
401	`invalid_api_key`	Кілт жоқ, оның күші жойылған немесе оның пайдаланушысы өшірілген.
404	`not_found`	Эндпоинт жоқ, не элемент жоқ немесе ол пайдаланушы көре алмайтын ұйымға тиесілі.
404	`organization_not_found`	Көрсетілген `organization` пайдаланушы осы түрдегі элементтерді көре алатын ұйымға жатпайды.
405	`method_not_allowed`	API тек `GET` (және `HEAD`) әдісін қабылдайды.
429	`rate_limited`	Сұраныстар шегіне жетті. `Retry-After` ішінде көрсетілген секунд санын күтіңіз.
500	`server_error`	Ішкі қате. Біраздан кейін қайталап көріңіз; қате қайталана берсе, қолдау қызметіне хабарласыңыз.

Қашан қайталау керек

Дәл сол сұранысты тек 429 (Retry-After уақытын күткеннен кейін) немесе 500 қатесінен кейін қайталаған жөн. Басқа қателер сұранысты немесе кілтті түзетуді талап етеді.