API документация
Все описания методов API составлены по одному принципу и содержат заголовок (slug) в следующем формате:
HTTP_METHOD module/method
Эта запись подразумевает, что метод method модуля module доступен по ссылке: https://itapi.iterios.com/api/v1/module/method. За основу взяты принципы REST сервиса, поэтому важно учитывать, какой HTTP_METHOD указан для запроса. Так, запрос GET module/method предназначен для получения информации, а POST module/method — для создания записи.
Статусы ответов для всех методов имеют одинаковое значение и описаны в таблице ниже.
| Код | Описание |
|---|---|
| 200 | Успешное выполнение. Ожидаемая информация будет доступна по ключу data. Для данного статуса ключ data возвращается всегда. |
| 400 | Параметры переданы неверно, подробности доступны по ключам exception (наименование ошибки), message(сообщение для пользователя),status, соответствующий статусу ответа, data (необязательный, содержит подробности ошибок валидации по принятому запросу) |
| 401 | Ошибка авторизации, описана ниже в разделе Авторизация |
| 403 | Ошибка авторизации, описана ниже в разделе Авторизация |
| 500 | Внутренняя ошибка. Подробности доступны по ключам exception (наименование ошибки), message(сообщение для пользователя),status, соответствующий статусу ответа |
Авторизация
Для авторизации используется специальный заголовок itapi-auth-token, в котором передается ключ, полученный при регистрации. Cookies не используются. На данный момент работать с ITAPI строго рекомендуется в связке сервер-сервер, иначе пользователи смогут воспользоваться вашим ключом.
Пример запроса с использованием curl:
curl -H 'itapi-auth-token: some_key_value' https://itapi.iterios.com/api/v1/module/methodКлюч выдается после регистрации на сайте https://support.iterios.com/ru/get-itapi-key
Обработка ошибок
В случае, когда заголовок не был передан или его значение неправильное, ответ будет в формате JSON с кодом ответа 401 Unauthorized.
HTTP/1.1 401 Unauthorized
{
"exception": "Unauthorized",
"message": "Authorization token missed. Please send authorization token",
"status": 401
}В случае, когда выполнение запрошенного метода ограничено для вашего ключа, ответ будет в формате JSON с кодом ответа 403 Forbidden. Свяжитесь с поддержкой для уточнения деталей.
