Doiciméadú REST API
REST API
Cóid earráide
Gach cód earráide a thugann an API ar ais, lena stádas HTTP, a bhrí agus cad is féidir a dhéanamh faoi.
Cruth na hearráide
Is JSON iad earráidí sa chruth seo. Brainseáil ar code, nach n-athraíonn riamh; is do dhaoine atá message agus d’fhéadfadh sé athrú. Liostaíonn details gach réimse neamhbhailí i gcás 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Cóid
Nasc go díreach le cód agus a ainm mar ancaire, mar shampla /docs/api/errors#rate_limited.
- 400invalid_request
- Tá an corp, an t-iarratas nó ceanntásc neamhbhailí. Ainmníonn details gach réimse a bhfuil fadhb leis. Ceartaigh an t-iarratas; teipfidh sé arís má dhéantar athiarracht air gan athrú.
- 401api_key_expired
- Tá dáta éaga na heochrach caite. Cruthaigh eochair nua, nó rothlaigh an eochair chun rún nua a fháil.
- 401api_key_revoked
- Cúlghaireadh an eochair. Cruthaigh eochair nua in Socruithe › Forbróirí.
- 401invalid_api_key
- Ní mheaitseálann aon eochair. Seiceáil gur cóipeáladh an eochair iomlán, nó cruthaigh ceann nua in Socruithe › Forbróirí.
- 402insufficient_credits
- Tá creidmheasanna IS úinéir na heochrach ídithe. Breisigh nó uasghrádaigh in Attorly, ansin bain triail eile as.
- 402usage_limit_exceeded
- Sroicheadh teorainn úsáide IS d’úinéir na heochrach nó don eagraíocht. Athshocraítear í leis an tréimhse billeála; is féidir le riarthóir eagraíochta teorainn baill a ardú.
- 403ai_consent_withdrawn
- Tharraing úinéir na heochrach, nó úinéir an doiciméid, toiliú do phróiseáil IS siar. Is féidir é a thabhairt arís faoi Socruithe › Príobháideachas.
- 403forbidden
- Is féidir leis an eochair an acmhainn a léamh ach ní féidir léi í a athrú, nó níl an gníomh ceadaithe di. Iarr rochtain eagarthóireachta ar an úinéir.
- 403insufficient_scope
- Níl cead ag an eochair atá de dhíth ar an oibríocht seo; ainmníonn an teachtaireacht é. Cruthaigh eochair a bhfuil an cead sin aici.
- 403ip_not_allowed
- Tá liosta ceadaithe IP ag an eochair agus tháinig an t-iarratas ó sheoladh lasmuigh de. Glaoigh ó sheoladh ceadaithe, nó athraigh an liosta ceadaithe in Socruithe › Forbróirí.
- 403plan_required
- Níl rochtain API i bplean úinéir na heochrach, nó d’fhág an t-úinéir an eagraíocht. Tá Pro nó Fiontar de dhíth le haghaidh rochtain API.
- 404not_found
- Níl an acmhainn ann, nó ní féidir leis an eochair seo í a fheiceáil. Seiceáil an t-aitheantas agus go bhfuil rochtain ag úinéir na heochrach.
- 405method_not_allowed
- Ní thacaíonn an chonair leis an modh HTTP seo. Liostaíonn an ceanntásc Allow na modhanna a dtacaíonn sí leo.
- 409conflict
- Tá an t-iarratas ag teacht salach ar staid reatha na hacmhainne, mar shampla gníomh atá déanta cheana. Léigh an acmhainn agus cinn arís.
- 409idempotency_request_in_progress
- Tá iarratas leis an Idempotency-Key céanna fós ag rith. Ceistigh an ceanntásc Location, nó bain triail eile as tar éis Retry-After soicind.
- 413payload_too_large
- Tá an corp nó an comhad uaslódáilte rómhór. Is féidir le comhaid a bheith suas le 10 MB.
- 415unsupported_media_type
- Tá an corp i bhformáid nach nglacann an oibríocht seo léi. Seol JSON, nó multipart/form-data nuair a ghlactar le huaslódáil.
- 422idempotency_key_reused
- Úsáideadh an Idempotency-Key cheana d’iarratas eile. Úsáid eochair nua do gach iarratas ar leith.
- 422unprocessable
- Tá an t-iarratas bailí ach ní féidir é a dhéanamh, mar shampla anailís ar dhoiciméad nach bhfuil dlí rialaitheach roghnaithe dó. Insíonn an teachtaireacht cad atá ar iarraidh.
- 429concurrency_limit_exceeded
- Tá an oiread oibríochtaí IS fadréimseacha ag rith ag d’eagraíocht agus is féidir léi ag an am céanna. Fan go gcríochnóidh ceann acu, nó go n-imeoidh na soicindí in Retry-After, ansin bain triail eile as.
- 429rate_limited
- An iomarca iarratas i gceann de na fuinneoga a n-áirítear an eochair seo ina gcoinne. Fan an líon soicindí in Retry-After, ansin bain triail eile as. Taispeánann an ceanntásc RateLimit cén fhuinneog atá lán.
- 500internal_error
- Chuaigh rud éigin amú ag Attorly. Bain triail eile as leis an Idempotency-Key céanna; má leanann sé, déan teagmháil leis an bhfoireann tacaíochta agus an requestId agat.
- 504timeout
- Níor chríochnaigh an oibríocht in am. Bain triail eile as leis an Idempotency-Key céanna, nó seol Prefer: respond-async agus ceistigh an oibríocht.