Ошибки API

ID статьи: 390

Последнее обновление: 5 дек., 2017

Содержание:

KBPublisher использует обычные коды HTTP-ответов, чтобы известить об успешной или неудачной попытке API-запроса. Коды в диапазоне 2xx указывают на успешную попытку, коды в диапазоне 4xx ‒ на ошибку, возникшую в результате передачи информации (например, отсутствовал требуемый параметр и т. д.), а коды в диапазоне 5xx указывают на ошибку сервера, БД или API.

Список кодов HTTP-состояний

200 OK – Процедура выполнена успешно.
400 Bad Request – Часто возникает в случаях, когда отсутствует требуемый параметр. Неверный запрос.
401 Unauthorized – Отсутствует действующий ключ API. Неверная подпись.
402 Request Failed – Параметры допустимы, но запрос не выполнен.
404 Not Found – Запрошенный элемент не существует.
500, 502, 503, 504 Server errors – На сервере возникла ошибка.

Коды ошибок

В дополнение к тексту ошибки, сообщения содержат коды. Текст сообщения об ошибке может измениться, но коды останутся неизменными. В следующей таблице приведены коды, которые могут появится при работе с API:

Код	Текст	Код HTTP	Описание
3	Authentication failed	401	Невозможно аутентифицировать пользователя.
4	Authorization failed	401	Неверная подпись. Запрос нельзя принять.
21	API is available via SSL only	400	Для отправки запроса используйте HTTPS.
22	You cannot access this resource using (%s) request	400	Недопустимый метод HTTP-запроса (POST, PUT или DELETE).
23	Sorry, that page does not exist	400	Указанный источник не найден.
24	Sorry, that method does not exist	400	Указанный метод не найден.
25	Missing or invalid argument(s)	400	Отсутствует требуемый параметр или параметр недопустим.
11	Database error	500	Ошибка базы данных.
28	API is not available	503	API выключен.
29	API is temporarily unavailable	503	API не отвечает.
31	Not found	404	Запрошенный элемент не существует.

Если встретилось сообщение об ошибке, которое отсутствует в приведенной выше таблице, вернитесь к коду HTTP-состояния, чтобы найти подходящий способ устранить ошибку.

Сообщения об ошибках

API KBPublisher возвращает сообщения об ошибке в запрошенном формате. Например, ошибка метода JSON может выглядеть так:

{

    "errors":[

        {

            "errorCode": 25,

            "errorMessage": "Missing or invalid argument(s)",

            "errorInfo": "Required argument(s): timestamp"

         }

      ]

}

Соответствующий XML-ответ будет выглядеть так:

<?xml version="1.0" encoding="UTF-8"?>

<errors>

    <error>

        <errorCode>25</errorCode>

        <errorMessage>Missing or invalid argument(s)</errorMessage>

        <errorInfo>Required argument(s): timestamp</errorInfo>

    </error>

</errors>

Поле errorInfo является необязательным в ответе ошибки.