Błędy
Jeden kształt, dwa poziomy i identyfikator żądania na wszystkim.
Koperta
type to zamknięty zbiór, na którym możesz się rozgałęziać, i nigdy się nie powiększy. code jest szczegółowy i przyrostowy, więc taki, którego nie rozpoznajesz, traktuj jak jego type. requestId jest w każdej odpowiedzi, również udanej, i to on wiąże zgłoszenie z wierszem dziennika.
{ "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 jest zapisany z kropkami i indeksami, więc wskazuje dokładny element (to.0, attachments.2.filename), a nie pole, które go zawiera.
Kody statusu
| Status | type | Typowe kody |
|---|---|---|
| 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 nigdy nie odróżnia „nie istnieje” od „należy do innej przestrzeni roboczej”. To celowe: sama ta różnica jest informacją.
429 nigdy nie niesie Retry-After, więc wybierz własny czas oczekiwania. send_quota_exceeded to miesięczny limit wysyłek i resetuje się pierwszego dnia miesiąca, więc pokaż go człowiekowi, zamiast się wycofywać. too_many_inboxes to pułap tworzenia jednorazowych skrzynek, a przedłużenie skrzynki, którą już masz, nic z niego nie zabiera.
500 i 503 dzielą type, a dla wywołującego znaczą różne rzeczy. 503 to zależność, która nie odpowiedziała (dziś jest to tłumacz), i żądanie warto ponowić bez zmian; 500 jest po naszej stronie i warto je zgłosić razem z jego requestId.
Obsługa błędów
Rozgałęziaj się na type dla zachowania i czytaj code dla komunikatu, który pokazujesz człowiekowi. Nierozpoznany code nie jest błędem w twoim kliencie. Oznacza, że nazwaliśmy awarię precyzyjniej niż wcześniej.
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); }}