Золотенков

Коды ответа и ошибки

Ошибка всегда приходит одним и тем же телом: машинный код, текст для человека и идентификатор запроса.

Решение принимают по полю error: текст message предназначен человеку и может меняться. request_id сохраняют в свой журнал — по нему разбирают обращение в поддержку.

Тело ошибки
{
  "error": "validation_failed",
  "message": "Поле title обязательно",
  "request_id": "0f9c1f2e-6f1c-4c1b-9a2f-3f7d1c9b8a21"
}

Коды

КодЧто значит
200 Запрос выполнен
201 Документ создан
400 Некорректное тело, фильтр или курсор
401 Ключ не передан, недействителен или отозван
402 Исчерпан лимит тарифа
403 У ключа нет нужного права
404 Объекта нет в этом учете
409 Idempotency-Key повторен с другим телом либо документ уже не редактируется
422 Действие противоречит учету: закрытый период, дата в будущем
429 Превышена частота обращений или суточный предел документов

Чужого не видно

Объект другой учетной записи отвечает 404, а не 403. Иначе разница между ответами позволяла бы перебором узнать, что у соседа заведено.