Առաջին քայլեր
Սխալներ
Երբ ինչ-որ բան սխալ է ընթանում, 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 սխալից հետո։ Մյուս սխալները պահանջում են ուղղել հարցումը կամ բանալին։