Всё API принимает и возвращает данные в формате JSON.
YYYY-MM-DD
(только дата), YYYY-MM-DDThh:mm:ss±hh
(дата и время);Авторизация происходит посредством заголовка Authorization: Bearer {TOKEN}
, где {TOKEN}
– токен аккаунта, который можно получить в Личном кабинете или через API по E-mail и паролю.
В случае успеха возвращается ответ со статусом 200
, 201
или 204
. Если в запросе отсутствует заголовок авторизации или в заголовке передан некорректный токен, будет возвращёт ответ со статусом 401
. Если переданы некорректные параметры, либо возникла ошибка иного рода, из-за которой невозможно обработать запрос, API вернёт ответ с 400
статусом и кодом ошибки.
Для постраничной навигации в API списков используются параметры page
и perPage
. По умолчанию выводится 20 результатов на страницу, максимально допустимое количество результатов на страницу – 1 000. Для получения полного списка результатов (но не больше максимально допустимого числа), без постраничной навигации, передавайте perPage
со значением 0
.
X-Pagination-Current-Page
– номер текущей запрошенной страницы;X-Pagination-Page-Count
– общее количество страниц в списке;X-Pagination-Per-Page
– количество выводимых результатов на страницу;X-Pagination-Total-Count
– общее количество результатов в списке.Ссылка на Swagger.
Расшифровка кодов ошибок.