В этом разделе описаны структура и общие ошибки системы Escrow Box.
Общая структура ошибок
Все обработанные ошибки сервиса Escrow Box возвращаються со статус кодом 400 в формате JSON одинаковой структуры.
Пример полной структури:
{
"error": {
"code": "SOME_CODE",
"message": "Some description of the error",
"fields": {
"someField": "SOME_CODE"
}
}
}
Описание полей ошибок:
| Поле | Обязательное | Описание |
|---|---|---|
| error | Да | Объект ошибки, вмещает подробности об ошибке |
| error.code | Да | Текстовый код ошибки |
| error.message | Нет | Краткое текстовое описание ошибки |
| error.fields | Нет | Объект который показывает к какому(-им) из полей запроса относиться ошибка, обьект дублирует структуру таких полей и в значение записывает текстовый код ошибки |
Ошибки
| code | message | Описание | Пример |
|---|---|---|---|
| NOT_ALLOWED | Authorization credentials are required | Не передан HTTP header Authorization, либо передан, но не правильной структуры или не правильно зашифрован | {
"error": {
"code": "NOT_ALLOWED",
"message": "Authorization credentials are required"
}
}
|
| NOT_ALLOWED | Wrong authorization credentials have been passed to headers | Передаваемые авторизационные данные(логин и пароль) неверны | {
"error": {
"code": "NOT_ALLOWED",
"message": "Wrong authorization credentials have been passed to headers"
}
}
|
| NOT_ALLOWED | Client is not ACTIVE | Аккаунт отключен администраторами | {
"error": {
"code": "NOT_ALLOWED",
"message": "Client is not ACTIVE"
}
}
|
| UNKNOWN_ERROR |
| Необработанная/неизвестная ошибка Если вам в ответ на какой то из запросов к EscrowBox вернулась подобная ошибка, просим обратиться в нашу техподдержку с подробными логами(примерное время выполнения запроса, от какого ID клиента, URL на который был отправлен запрос, HTTP методо, тело запроса, если имееться, и сам ответ). | {
"error": {
"code": "UNKNOWN_ERROR",
"message": "Internal server error"
}
}
|