Overview

Ошибки API: коды ответов и request_id

{
  "error": { "code": "unauthorized", "message": "Missing bearer token" },
  "request_id": "f04e847d-8505-4b7b-a5c8-7aee42a8fc55"
}

Поле request_id#

request_id — уникальный идентификатор конкретного вызова. Логируйте его на своей стороне: по нему поддержка находит запрос в логах, не переспрашивая время, тело и заголовки. Без него разбор одного упавшего вызова превращается в переписку на день.

Коды ответов#

Код Когда возникает Что делать
200 Запрос выполнен
401 Заголовок Authorization отсутствует либо токен недействителен или истёк Проверьте авторизацию
404 Адрес не существует. Форма ответа отличается: {"detail":"Not Found"} Сверьте путь и версию со справочником
422 Тело или параметры не прошли валидацию Смотрите detail — там перечислено, какое поле и почему отклонено

Форма ошибки валидации#

Ответ 422 содержит список проблемных полей: для каждого указано место в запросе (loc), сообщение (msg) и тип ошибки (type).

{
  "detail": [
    { "loc": ["body", "field_name"], "msg": "field required", "type": "value_error.missing" }
  ]
}

Ошибка сертификата — не ошибка API#

Если клиент прерывает соединение на проверке TLS-сертификата, ответа от API нет вовсе: api.nexifyneo.com отдаёт самоподписанный сертификат. Такой сбой не имеет ни кода, ни request_id, и искать его в логах API бессмысленно. Подробности — Известные ограничения.

Дальше#

Updated

Ошибки API: коды ответов и request_id — NN Agent