Содержание
- Описание API и документация
- Создание приложения
- Получение access token
- Авторизация через Oauth 2.0
- Ограничения
Описание API и документация
API нашей платформы позволяют интегрировать большую часть наших возможностей в ваше решение и тем самым организовать двусторонний обмен данными.
- Полная документация по API доступна по ссылке.
- Описание методов 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 и вашим сайтом.
Подробная документация по ссылке:
https://go.teachbase.ru/libs/documents/auth_provider_docs.pdf
Ограничения
Рекомендуем при работе с API использовать не более 50 запросов в секунду.