Open API

В ASAP можно обращаться из сторонних решений с помощью Open API. Open API работает через HTTP и представляет набор методов запрос/ответ.

API-запросы необходимо отправлять по следующему адресу:

<URL портала ASAP, используемого для взаимодействия через Open API>/openapi/<Версия API>/<запрос>

Как получить URL ASAP, используемого для взаимодействия через API

Чтобы получить ASAP Open API URL:

1. Войдите в веб-интерфейс платформы ASAP.
2. В разделе Контрольная панель нажмите на кнопку Импорт и синхронизация, а затем откройте закладку Open API.
3. Ссылка для обращения к ASAP через Open API расположена в нижней части окна. Скопируйте ее и сохраните любым удобным для вас способом.

Как включить доступ по API и сгенерировать токен

Для авторизации запросов их необходимо подписывать токеном, созданном в платформе ASAP. Только администраторы компании могут создать токены.

Чтобы создать токен:

1. Войдите в веб-интерфейс платформы ASAP.
2. В разделе Контрольная панель нажмите на кнопку Импорт и синхронизация, а затем откройте закладку Open API.
3. Нажмите на кнопку Новый токен.

   Откроется окно Получить токен.

4. Скопируйте токен и сохраните его любым удобным для вас способом.

Токен не хранится в системе ASAP в открытом виде. После закрытия окна Получить токен он становится недоступным для просмотра. Если вы закрыли это окно, не скопировав токен, вам требуется нажать на кнопку Новый токен повторно, чтобы система сгенерировала новый токен.

Выпущенный токен действителен в течение 12 месяцев. По истечении этого срока токен будет отозван. Выпущенный токен будет также отозван, если он не используется в течении 6 месяцев.

Авторизация

Полученный в ASAP токен необходимо добавлять в заголовки всех API-запросов. Заголовок должен выглядеть следующим образом:

Authorization: Bearer <токен, полученный в платформе ASAP> ContentType 'application/json; charset=utf-8'

Формат ответа

JSON является поддерживаемым по умолчанию форматом ответов на API-запросы.

Пример CURL-вызова

Ниже показан API-запрос на адрес https://domain.com/, в котором используется метод GET openapi/v1/groups (получение списка групп). В запросе используется авторизация токеном e8c699c05d495566a94bbb6841894153.

curl -X GET "https://domain.com/openapi/v1/groups" -H "accept: application/json" -H "Authorization: Bearer Token:e8c699c05d495566a94bbb6841894153"

Методы ASAP Open API, используемые для интеграции с системами управления обучением (LMS)

Доступные методы интеграции с системами управления обучением:

1. /users/info – получение персональной ссылки на портал пользователя.
2. /groups – получение списка групп, доступных для данной компании.
3. /users – создание пользователя с добавлением его в указанную группу.
4. /report – сформировать отчетные данные по пользователям, зарегистрированным на портале и проходящим обучение по программам ASAP.
5. /user – внесение изменений в данных о пользователе. Перемещение сотрудника компании в другую учебную группу.

Допустимая нагрузка каждого метода составляет не более 10 запросов в секунду (RPS).

В этом разделе справки Примеры использования открытого API Метод POST /openapi/v1/users/info Метод GET /openapi/v1/groups Метод POST /openapi/v1/users Метод POST /openapi/v1/report Метод PATCH /openapi/v1/user/:userId Метод DELETE /openapi/v1/user/:userId

В начало