Коды ошибок

Любой ответ API с кодом 4xx или 5xx имеет одно и то же тело:

{ "error": { "code": "route_not_found", "message": "Route not found" } }

Каждый ответ, включая ошибки, содержит заголовок X-Request-Id. Сообщайте его при обращении в поддержку: по нему находится запрос в логах. Если клиент сам передал X-Request-Id из латинских букв, цифр и символов ., _, :, - длиной до 128 символов, сервис использует его, иначе генерирует UUID.

Перечень

Если клиент получил код, которого нет в таблице, он должен обработать ответ по классу HTTP-статуса: 4xx — ошибка в запросе, 5xx — временная проблема сервиса.

Примеры

curl -s https://api.stons.io/v1/unknown

{"error":{"code":"route_not_found","message":"Route not found"}}

Ошибка проверки перечисляет все проблемные поля:

{
  "error": {
    "code": "validation_failed",
    "message": "Request validation failed",
    "details": [{ "path": "body.expires_in", "message": "Too small: expected number to be >=60" }]
  }
}