Chyby
Jeden tvar, dvě úrovně a request id úplně na všem.
Obálka
type je zmrazená množina, na kterou se dá větvit, a nikdy neporoste. code je konkrétní a aditivní, takže s tím, který neznáte, zacházejte jako s jeho type. requestId je v každé odpovědi, i v úspěšné, a je to ono pojítko mezi hlášením a řádkem v logu.
{ "error": { "type": "validation_error", "code": "invalid_email_address", "message": "Not a valid email address: ada@", "param": "to.0", "docUrl": "https://openemail.uk/docs/api/errors#invalid_email_address", "requestId": "req_e103790543af4…" }}param je zapsaný tečkovaně a s indexem, takže ukazuje na přesný prvek (to.0, attachments.2.filename), a ne na pole, které ho obsahuje.
Stavové kódy
| Stav | type | Běžné kódy |
|---|---|---|
| 400 | invalid_request_error | malformed_json, invalid_idempotency_key |
| 401 | authentication_error | missing_api_key, invalid_api_key, revoked_api_key, invalid_credential_type |
| 403 | permission_error | insufficient_scope, from_address_forbidden |
| 404 | not_found_error | resource_not_found |
| 409 | conflict_error | email_not_cancellable, translation_not_configured |
| 422 | validation_error | invalid_email_address, reserved_header, too_many_recipients, unknown_parameter, idempotency_key_reuse, label_not_directly_settable, unknown_language, translation_too_long |
| 429 | rate_limit_error | send_quota_exceeded, too_many_inboxes |
| 500 | api_error | internal_error |
| 503 | api_error | translation_failed |
404 nikdy nerozlišuje mezi „neexistuje“ a „patří jinému workspace“. Je to záměr: ten rozdíl je sám o sobě informace.
429 nikdy nenese Retry-After, takže si čekání zvolte sami. send_quota_exceeded je měsíční limit odeslání a resetuje se prvního dne v měsíci, takže ho ukažte člověku, místo abyste couvali s exponenciálním čekáním. too_many_inboxes je strop na zakládání jednorázových schránek a prodloužení schránky, kterou už držíte, proti němu nic nestojí.
500 a 503 sdílejí type a pro volajícího znamenají různé věci. 503 je závislost, která neodpověděla (dnes je to překladač), a požadavek se vyplatí zopakovat beze změny; 500 je na naší straně a vyplatí se ho nahlásit i s jeho requestId.
Zpracování chyb
Na type větvete chování a code čtěte kvůli zprávě, kterou ukážete člověku. Nerozpoznaný code není chyba ve vašem klientovi. Znamená, že jsme selhání pojmenovali přesněji než dřív.
const res = await fetch(`${BASE}/emails`, { method: 'POST', headers, body }); if (!res.ok) { const { error } = await res.json(); switch (error.type) { case 'rate_limit_error': throw new RateLimited(error.code); case 'validation_error': // error.param points at the offending field throw new BadRequest(`${error.param}: ${error.message}`); case 'authentication_error': // revoked_api_key and expired_api_key are worth telling an operator apart throw new AuthFailed(error.code); default: // quote requestId when you report it throw new Unexpected(error.message, error.requestId); }}