🧊 Настройки. Модуль API

Статья могут интегрировать платформу ProgressMe с внешними сервисами через программный интерфейс (API).

Модуль API

Использование и генерация API-ключа

Генерация ключа авторизации

API-ключ (токен) используется для авторизации внешних приложений, взаимодействующих с платформой через API.

Ключ генерируется однократно — сразу после создания он отображается в открытом виде, и важно сохранить его в безопасном месте. После закрытия окна или обновления страницы ключ более не будет доступен для просмотра. Это стандартная мера безопасности.

Если необходимо, ключ можно:

  • удалить

  • сгенерировать новый (предыдущий станет неактивным)

Таким образом, один активный ключ может быть действительным в системе в любой момент времени.

Использование API

Для взаимодействия с системой через API предоставляется открытая документация в формате Swagger. Она содержит перечень доступных методов — исключительно тех, которые поддерживаются платформой.

Важно учитывать, что:

  • API предоставляет частичный доступ к действиям, связанным с пользователями и курсами, но не охватывает всю административную логику платформы

  • отсутствуют методы, например, для удаления учеников или их исключения из марафонов

Поддержка и сопровождение

  • Пользователи могут самостоятельно настраивать интеграции с помощью токена авторизации

  • В случае возникновения технических ошибок при обращении к API Техническая поддержка поможет разобраться

Однако вопросы настройки интеграций и автоматизации процессов находятся вне зоны ответственности платформы — они выполняются пользователем самостоятельно.

No-code интеграции

Для пользователей без опыта программирования возможна работа через сервис Альбата — отечественный аналог Zapier.

Альбата позволяет:

  • использовать готовые сценарии и шаблоны интеграций

  • настраивать подключение между платформами без необходимости писать код

  • работать с любыми сервисами, у которых есть открытое API

Это особенно удобно, если необходима интеграция с CRM-системами или другими внешними инструментами.


👆 На этом пока всё