error.type және error.code өрістері бойынша тармақталыңыз. error.message мәтінін сол күйінде көрсетіңіз немесе журналға жазыңыз, бірақ оны бағдарламамен талдамаңыз: тұжырымдар өзгеріп тұрады.
Қате қалай көрінеді
error.type өрісі әрқашан бар, және әр түрдің өз HTTP күйі болады. error.code өрісі себепті нақтылайды. Ол барлық қатеде бола бермейді: ол жоқ болса, түр мен мәтін жеткілікті. Бейтаныс кодты түрі бойынша өңдеңіз.
request_id өрісі — сұраудың нөмірі. Сол нөмір әр жауаптың, оның ішінде сәтті жауаптың да, x-request-id тақырыбында келеді. Оны өз журналыңызда сақтаңыз: сол бойынша сұрау «Сұраулар журналы» бөлімінен табылады.
Сұрау өрістерді тексеруден өтпесе, validation_failed кодымен 400 келеді. Сонда error.fields ішінде әр өрісте не дұрыс емес екені тізіледі: жол, код және мәтін.
Негізгі бас тартулар
Басты айырмашылық — бас тарту өздігінен өте ме, жоқ па. Жиілікке байланысты бас тарту өтеді: күте тұрып, қайталаңыз. Ақшаға, құқықтарға немесе кілттің күйіне байланысты бас тарту кабинеттегі адам бірдеңені өзгертпейінше өтпейді. Мұндай сұрауды циклмен қайталаудан пайда жоқ.
Бөгде ұйымдар, компаниялар және құжаттар 403 емес, 404 қайтарады. Осылай API олардың бар екенін ашпайды. Компания анық бар болса, ал сұрау 404 қайтарса, оның кілт компанияларына кіретінін тексеріңіз.
ЖИ-бухгалтерге жіберілген сұрауға кодсыз келген 409 күйі көбінесе компанияның 1С-ке қосылмағанын білдіреді. Себебі
error.message ішінде жазылған. Қосылым күйін GET /v1/companies/{co}/onec/status көрсетеді.
401 және 402 бас тартулары туралы Кілт жұмыс істемейді бетінде толығырақ жазылған. Кодтардың толық тізімі API анықтамасында, қатенің сипаттамасында бар.
Сұраулар жиілігі
Кілт бойынша сұраулар минут сайын есептеледі. Шек екеу: бір кілтке және ұйымның барлық кілтіне бірге. Қайсысы тарырақ болса, сол қолданылады. Кілт бойынша әр жауапта үш тақырып болады, солардан қанша қалғаны көрінеді:x-ratelimit-limit— ағымдағы терезеде қанша сұрау жіберуге болады.x-ratelimit-remaining— олардың қаншасы қалды.x-ratelimit-reset— жаңа терезе неше секундтан кейін басталады.
rate_limited кодымен және секундпен берілген Retry-After тақырыбымен 429 келеді. Көрсетілген уақытты күтіп, сұрауды қайталаңыз. Қате кілтпен тым көп сұрау келген мекенжай да осы бас тартуды алады.
Шектердің өзі бұл құжаттамада келтірілмейді, өйткені олар өзгеруі мүмкін. Қолданыстағы мәндер мен кілт бойынша қалдықты мына сұрау береді:
ЖИ-бухгалтерге бір мезгілде жіберілетін сұраулар
Бір кілт бойынша бір мезгілде ЖИ-бухгалтердің шектеулі жауабы ғана жүре алады. Бұл — бөлек шектеу, оның жиілікке қатысы жоқ. Одан асқан сұрауconcurrent_turns_limit кодымен және Retry-After тақырыбымен 429 алады. Ағымдағы шек пен бос емес орындар саны сол шектер сұрауының жауабында, concurrent_turns өрісінде жатыр.
Бірден көп сұрақ қою керек болса, оларды өз жағыңызда кезекке қойып, бір мезгілдегі сұраулар санын шектен төмен ұстаңыз. Бір чатта жауаптар қатаң түрде бір-бірден жүреді.
Сұраулардың өлшемдері
ЖИ-бухгалтерге қойылатын сұрақ 4000 таңбаға дейінгі ұзындықта қабылданады. Сұраққа файлдар тіркеуге болады. Қанша файлға және қандай өлшемге рұқсат етілетінін, сондай-ақ сұрау денесінің ең үлкен өлшемін сол шектер сұрауыfiles өрісінде береді. Тым үлкен сұрау payload_too_large кодымен 413 алады.
Браузерден шақыру
API браузердегі бет кодынан келетін сұрауларды, яғни CORS-ты қолдамайды. Кілт — құпия, ал браузерде оны кез келген келуші көреді./v1 мекенжайларына жіберілген алдын ала OPTIONS сұрауы cors_not_supported кодымен 403 қайтарады. API-ді өз серверіңізден шақырыңыз, ал бетке дайын нәтижені беріңіз.
Әрі қарай
- Кілт жұмыс істемейді: бас тартуларды бір-бірлеп, әрекеттерімен талдау.
- Платформа балансы және шығын: 402 келуіне себеп болатын толтыру мен шектер.
- Алғашқы сұрауды жіберу:
Idempotency-Keyтақырыбы және қауіпсіз қайталаулар.