Joan eduki nagusira
REST APIaren dokumentazioa

REST APIa

Errore-kodeak

APIak itzultzen dituen errore-kode guztiak, haien HTTP egoerarekin, zer esan nahi duten eta zer egin behar den.

Errorearen forma

Erroreak forma honetako JSONa dira. Adarkatu code eremuaren arabera, ez baita inoiz aldatzen; message pertsonentzat da eta alda daiteke. details eremuak 400 errore bateko eremu baliogabe bakoitza zerrendatzen du.

json
{
  "error": {
    "code": "insufficient_scope",
    "message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
    "requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
  }
}

Kodeak

Estekatu kode bat zuzenean bere izena aingura gisa erabiliz, adibidez /docs/api/errors#rate_limited.

400invalid_request
Gorputza, kontsulta edo goiburu bat baliogabea da. details eremuak arazoa duen eremu bakoitza izendatzen du. Zuzendu eskaera; aldatu gabe errepikatzeak berriro huts egingo du.
401api_key_expired
Gakoaren iraungitze-data igaro da. Sortu gako berri bat, edo berritu gakoa sekretu berri bat lortzeko.
401api_key_revoked
Gakoa baliogabetu da. Sortu gako berri bat Ezarpenak › Garatzaileak atalean.
401invalid_api_key
Ez dago bat datorren gakorik. Egiaztatu gako osoa kopiatu dela, edo sortu berri bat Ezarpenak › Garatzaileak atalean.
401unauthorized
Authorization goiburua falta da, edo ez da Bearer hitza eta ondoren gakoa. Bidali gakoa Bearer token gisa.
402insufficient_credits
Gakoaren jabearen AA kredituak agortu dira. Kargatu kredituak edo hobetu plana Attorlyn, eta saiatu berriro.
402usage_limit_exceeded
Gakoaren jabearen edo erakundearen AA erabilera-muga bat iritsi da. Fakturazio-aldiarekin berrezartzen da; erakundeko administratzaile batek kide baten muga igo dezake.
403forbidden
Gakoak baliabidea irakur dezake, baina ez aldatu, edo ekintza ez dago baimenduta harentzat. Eskatu jabeari edizio-sarbidea.
403insufficient_scope
Gakoak ez du eragiketa honek behar duen baimen bat; mezuak izendatzen du. Sortu baimen hori duen gako bat.
403ip_not_allowed
Gakoak IP onarpen-zerrenda bat du, eta eskaera zerrendatik kanpoko helbide batetik etorri da. Deitu baimendutako helbide batetik, edo aldatu onarpen-zerrenda Ezarpenak › Garatzaileak atalean.
403plan_required
Gakoaren jabearen planak ez du APIrako sarbiderik, edo jabeak erakundea utzi du. APIrako sarbideak Pro edo Enterprise behar du.
404not_found
Baliabidea ez dago, edo gako honek ezin du ikusi. Egiaztatu IDa eta gakoaren jabeak sarbidea duela.
405method_not_allowed
Bideak ez du HTTP metodo hau onartzen. Allow goiburuak onartzen dituen metodoak zerrendatzen ditu.
409conflict
Eskaera baliabidearen uneko egoerarekin kontraesanean dago, adibidez dagoeneko egin den ekintza bat. Irakurri baliabidea eta erabaki berriro.
409idempotency_request_in_progress
Idempotency-Key bera duen eskaera bat oraindik exekutatzen ari da. Kontsultatu Location goiburua, edo saiatu berriro Retry-Afterreko segundoen ondoren.
413payload_too_large
Gorputza edo kargatutako fitxategia handiegia da. Fitxategiek gehienez 10 MB izan ditzakete.
415unsupported_media_type
Gorputza eragiketa honek onartzen ez duen formatu batean dago. Bidali JSON, edo multipart/form-data karga bat onartzen den tokian.
422idempotency_key_reused
Idempotency-Key lehenago beste eskaera baterako erabili zen. Erabili gako berri bat eskaera desberdin bakoitzerako.
422unprocessable
Eskaera baliozkoa da, baina ezin da egin; adibidez, lege aplikagarririk aukeratu gabeko dokumentu baten analisia. Mezuak adierazten du zer falta den.
429concurrency_limit_exceeded
Zure erakundeak dagoeneko aldi berean exekuta ditzakeen iraupen luzeko AA eragiketa guztiak exekutatzen ditu. Itxaron bat amaitu arte, edo Retry-Afterreko segundoak, eta saiatu berriro.
429rate_limited
Eskaera gehiegi gako honi dagozkion leihoetako batean. Itxaron Retry-Afterreko segundoak, eta saiatu berriro. RateLimit goiburuak erakusten du zein leiho dagoen beteta.
500internal_error
Zerbait gaizki joan da Attorlyn. Saiatu berriro Idempotency-Key berarekin; arazoak jarraitzen badu, jarri harremanetan laguntza-zerbitzuarekin requestId-arekin.
504timeout
Eragiketa ez da garaiz amaitu. Saiatu berriro Idempotency-Key berarekin, edo bidali Prefer: respond-async eta kontsultatu eragiketa aldizka.