Adobe Captivate Prime — это облачное решение для управления обучением, ориентированное на самостоятельную работу учащихся. API Prime предоставляет доступ к ресурсам системы, обеспечивая расширение системы Prime и ее интеграцию в другие приложения предприятия с целью организации удобного и непрерывного рабочего процесса. Также API может использоваться партнерами Adobe для добавления новых полезных элементов в систему Prime, расширения ее функций и интеграции с популярными приложениями и службами.
Captivate Prime API основывается на архитектурных принципах REST и предоставляет доступ к ключевым элементам объектной модели Prime, таким как User, Course, Learning Plan и Enrollment, в качестве ресурсов. Все API-запросы реализуются в контексте определенного пользователя, прошедшего аутентификацию с использованием учетных данных Prime. Таким образом, пользователь может получить доступ только к данным в пределах учетной записи, и этот доступ регулируется ролями пользователя и правами доступа, которыми он обладает.
Версия 1 Prime API была посвящена преимущественно обеспечению GET-доступа к большинству ресурсов. Полный исчерпывающий список конечных точек приведен в документации по API. Модель Prime содержит множество типов объектов (ресурсов) и отношений между ними. В связи с этим мы используем спецификацию JSONAPI v1.0, которая поддерживает стороннюю загрузку и полиморфность API-ответов.
Используя Prime API, разработчики могут разрабатывать отдельные приложения для расширения функций Prime и даже интеграции Prime в определенные рабочие процессы с вовлечением других приложений предприятия. Развертывание разработанных приложений обычно выполняется за пределами платформы Prime (это может быть веб-приложение, мобильное приложение или приложение для ПК). Соответственно, разработчик имеет полный контроль над управлением приложением на протяжении его жизненного цикла. Обычно приложения разрабатываются в компаниях клиентов для использования в учетных записях Prime. Такие приложения находятся в закрытом доступе только для сотрудников организации. Однако партнеры Adobe могут разрабатывать с использованием Prime API общие приложения, которые могу представлять интерес для широкого круга пользователей Prime.
В следующем разделе представлен общий обзор Prime API, а также приведен пример кода приложения. Остаток документа посвящен порядку получения разработчиками ключей для приложений и управления ими, а также подтверждения приложений для использования в учетных записях Prime. Подробные сведения о конечных точках и методах API приведены в документации по API.
Prime API
Prime API основывается на принципах REST и предоставляет разработчикам приложений ключевые элементы объектной модели Prime с помощью HTTP. Перед изучением подробных сведений о конечных точках API или методов HTTP разработчикам будет полезно ознакомиться с различными объектами Prime, их атрибутами и отношениями. После внимательного ознакомления с моделями имеет смысл получить базовое представление о структуре API-запросов и ответов, а также нескольких общих идиомах программирования, которые поддерживаются в API. Раздел завершается анализом примера кода простого приложения.
Модели Prime
Prime API позволяет разработчикам осуществлять доступ к объектам Prime как к ресурсам RESTful. Это означает, что в основном каждая конечная точка API представляет ресурс — обычно экземпляр объекта, например, Badge — или коллекцию таких объектов. Затем разработчики используют HTTP-команды — такие как PUT, GET, POST и DELETE — для выполнения операций CRUD с этими объектами (коллекциями).
В таблице ниже представлены различные элементы модели объекта Prime
Процесс разработки приложения
Разработка и тестирование
Получение учетной записи разработчика
Разработчикам рекомендуется создать пробную учетную запись Prime, с помощью которой они могут получить полный доступ к любым ролям. Для разработки приложения необходимо создать нескольких пользователей и несколько курсов, приведя учетную запись в рабочее состояние. Тогда приложение сможет получить доступ к данным, необходимым для его работы.
Создайте id и секрет клиента
Узнайте, как вы можете переключиться на роль администратора интеграции и зарегистрировать новое приложение. Предоставьте снимок экрана и опишите различные поля
Проведите разработку и тестирование приложения
Разработчики могут использовать Prime API для создания любых приложений. Для разработки необходимо, чтобы в пробной учетной записи были пользователи и курсы. Для тестирования функций приложения разработчику нужно создать несколько пользователей и курсов, симулируя деятельность в пробной учетной записи.
