Работа с API платформы
Описание API и документация
API нашей платформы позволяют интегрировать большую часть наших возможностей в ваше решение и тем самым организовать двусторонний обмен данными.
- Полная документация по API доступна по ссылке (opens in a new tab).
- Описание методов API и сущностей (дополняется) - ссылка. (opens in a new tab)
Создание приложения
Для работы с API необходимо создать "приложение". Чтобы это сделать, необходимо перейти в "Настройки", далее в верхнем меню нажать на "API и интеграции" и далее нажать на "Добавить приложение".
Вводим название (произвольное, например название сервиса, с которым будет интеграция) и сохраняем изменения. Поле «URI для редиректа» заполнять необязательно.
Приложение создано, ниже кнопки «Добавить приложение» появится информация о нем, необходимая для получения access_token
при авторизации. _«API публичный ключ» — это client_id
, а «API секретный ключ» — client_secret
.
Получение access_token
Для получения access_token необходимо проставить свои значения для client_id
и client_secret
в POST-запросе ниже. Полученный токен нужно использовать при любом запросе к API платформы.
POST <https://go.teachbase.ru/oauth/token?client\_secret=<client\_secret>&grant\_type=client\_credentials&client\_id=<client\_id><
Полученное значение access_token нужно будет добавлять в качестве заголовка ваших запросов к API в формате:
Authorization: Bearer <token>
где <token>
- значение полученного токена в формате строки.
Авторизация через протокол Oauth 2.0 (старая версия)
Позволяет настроить сквозную авторизацию между Teachbase и вашим сайтом.
Подробная документация по ссылке (opens in a new tab).
Авторизация через OAuth2.0 / OpenIDConnect
Документация описана в этой статье.
Ограничения
Рекомендуем при работе с API использовать не более 3 запросов в секунду. В противном случае, будет отдаваться HTTP код ошибки 429 - Too Many Requests.