Как использовать веб-сервис REST JSON
Веб-сервис REST JSON предоставляет доступ к данным YooLearn через API с поддержкой JSON и XML — используется для интеграций с внешними системами (CRM, кадровые системы, порталы). Инструкция предназначена для администраторов и разработчиков.
Предварительные условия
- Наличие прав администратора платформы.
- Понимание, какие данные и операции нужны внешней системе (списки пользователей, курсов, оценки и т.п.).
Основные шаги
- Войдите как администратор и перейдите в Администрирование → Плагины → Веб-сервисы → Управление веб-сервисами.
- Включите веб-сервисы и протокол REST protocol (with JSON/XML input support).
- Создайте роль веб-сервиса и назначьте ей необходимые права (например, просмотр пользователей или курсов).
- Создайте внешний сервис и добавьте в него нужные функции.
- Создайте токен для пользователя-интеграции.
- Передайте внешней системе адрес конечной точки, токен и список доступных функций.
После этого внешняя система сможет обращаться к API YooLearn: например, создавать пользователей, зачислять их на курсы или получать результаты обучения.
💡 Совет: для интеграций создавайте отдельного технического пользователя с минимально необходимыми правами — так проще контролировать доступ и отзывать его.
Важно: токен веб-сервиса даёт доступ к данным через API. Храните его в безопасном месте и не передавайте в открытых каналах.
Частые вопросы
- Проблема: API возвращает ошибку доступа. Решение: Проверьте, что веб-сервисы включены, у роли есть нужные права, а функции добавлены во внешний сервис.
- Проблема: Внешняя система не может подключиться. Решение: Проверьте адрес конечной точки, протокол и токен; убедитесь, что сервис активен.
- Проблема: Нужно добавить новую функцию в API. Решение: Откройте настройки внешнего сервиса и добавьте функцию в список разрешённых.