К содержимому

Разработчик

Док.

Разработчик

Документация API

Начните с адреса текущего стенда и проверки своего аккаунта. Схемы методов и обязательные поля доступны в Swagger.

Открыть Swagger ↗

Показаны все 4 раздела.

Адрес текущего стенда

Все кабинеты работают через единый домен. Адрес ниже соответствует сайту, который открыт сейчас.

Определяем адрес…
  1. Проверьте срок текущей сессии.
  2. Выполните запрос аккаунта в локальном инструменте.
  3. Выберите метод и схему в Swagger.

Аутентификация

Передавайте access token в заголовке Authorization: Bearer. Права зависят от роли и университета аккаунта. Не публикуйте токены в коде, скриншотах или журналах.

Проверить текущую сессию →

Первый запрос: мой аккаунт

Замените YOUR_ACCESS_TOKEN своим токеном в локальном инструменте. Пример не содержит данные текущей сессии.

curl '/api/v1/users/me' -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Ответы и ошибки

Формат ответа зависит от метода: объект, список или результат с пагинацией. Проверяйте схему выбранного запроса в Swagger и HTTP-статус перед чтением данных.

401
Сессия истекла или токен отсутствует. Выполните вход заново.
403
У аккаунта нет доступа к этому действию или университету.
400
Проверьте обязательные поля и формат значений.
Открыть обозреватель API →