Общие положения

Доступ к закрытым методам API:

По умолчанию, описание методов распознавания в справочнике API скрыты.
Для их отображения необходимо пройти процедуру авторизации, нажав кнопку "Login", используя учетные данные полученные от менеджера.
Кнопки авторизации

Рис. 1 - Кнопки авторизации

Форма авторизации

Рис. 2 - Форма авторизации

Запрос и ответ:

API использует JWT-аутентификацию.
Все запросы к API (кроме запросов из секции 'token') должны содержать заголовок Authorization: JWT "your_authorization_token",
где "your_authorization_token" — токен авторизации.
Запросы должны отправляться по протоколу HTTPS.

Отправка тестовых запросов:

Важно: при отправке POST-запросов в конце url адреса должен быть закрывающий слеш "/".
Cправочник API позволяет выполнить тестовые запросы.
Для этого необходимо получить токен доступа, выполнив запрос к методу аутентификации "/api/v0/token/"
Далее нужно заполнить поле JWT-ключа, в формате 'JWT "access_token"' в окне формы, которая появляется при нажатии кнопки "Authorize".

Форма JWT-аутентификации

Рис. 3 - Форма JWT-аутентификации

Страница запомнит указанный токен доступа, и будет использовать его при обращении к серверу.
Для отправки тестового запроса необходимо выбрать требуемый метод и нажать кнопку "Try it out" в описании к методу.
try it out button try it out button

Рис. 4 - Кнопки "Try it out" и "Execute"

Следующим шагом нужно заполнить параметры и выполнить запрос нажатием кнопки "execute".

Answer example

Рис. 5 - Пример ответа