Adobe Captivate Prime es una solución de gestión de aprendizaje automatizada basada en la nube y centrada en el alumno. La API de Captivate Prime proporciona acceso a recursos disponibles en dicho programa para facilitar el acceso mediante programación, con el fin de que los clientes puedan ampliar Captivate Prime e integrarlo con otras aplicaciones que utilicen para implementar flujos de trabajo bien definidos. Asimismo, los socios de Adobe pueden utilizar la API para mejorar la propuesta de valor de Captivate Prime ampliando sus funciones o mediante la integración con servicios o aplicaciones de uso extendido.
La API de Captivate Prime se basa en los principios arquitectónicos de REST y presenta como recursos elementos clave del modelo de objetos de Captivate Prime como Usuario, Curso, Plan de aprendizaje e Inscripción. Todas las solicitudes de API las efectúa un usuario concreto que se ha autenticado para acceder a una determinada cuenta de Captivate Prime. Por lo tanto, el usuario solo podrá acceder a los datos de esa cuenta, y estará sujeto a las funciones y los permisos de que disponga.
En la versión 1, la API de Captivate Prime se dedicaba principalmente a proporcionar acceso GET a la mayoría de los recursos. Consulte la documentación de la API para obtener una lista completa y detallada de los puntos finales y los métodos. Captivate Prime tiene un modelo de datos muy variado con varios tipos de objetos (recursos) e interrelaciones; por lo tanto, decidimos seguir la especificación JSONAPI v1.0, que permite cargas laterales y respuestas de API polimórficas.
Mediante la API de Captivate Prime, los desarrolladores pueden crear aplicaciones independientes que amplían las funciones de Captivate Prime o, incluso, la integran en el contexto de determinados flujos de trabajo en el que intervienen otras aplicaciones empresariales. La aplicación que se desarrolla suele implementarse fuera de la plataforma de Captivate Prime (podría ser una aplicación web, de escritorio o para dispositivos móviles) y el desarrollador controla de manera absoluta la gestión de dicha aplicación en el transcurso de su vida útil. En general, las aplicaciones las desarrolla una empresa de clientes que la quieren utilizar en su cuenta de Captivate Prime. Unas aplicaciones que son de ámbito interno en dicha empresa de clientes. Ahora bien, los socios de Adobe también pueden querer utilizar la API de Captivate Prime para crear aplicaciones genéricas de interés común para un amplio abanico de clientes de Captivate Prime.
La sección siguiente proporciona un resumen especializado de la API de Captivate Prime y efectúa un recorrido por el código de una aplicación de ejemplo. El resto de este documento se centra el procedimiento que siguen los ingenieros para obtener y administrar las claves de las aplicaciones, y en el modo de hacer que las aplicaciones sean fiables para utilizarlas en cuentas de Captivate Prime. Para obtener información sobre los diferentes métodos y puntos finales de la API, consulte la documentación de la API.
API de Captivate Prime
La API de Captivate Prime se basa en los principios de REST y presenta elementos clave del modelo de objetos de Captivate Prime a los desarrolladores de las aplicaciones mediante HTTP. Antes de entrar en los pormenores de la API y los métodos de HTTP propiamente dichos, es aconsejable que los desarrolladores se familiaricen con los diferentes objetos de Captivate Prime, sus atributos e interrelaciones. Cuando los modelos ya se comprendan bien, resultará útil tener nociones básicas sobre la estructura de las solicitudes y respuestas de la API, y de algunos lenguajes de programación conocidos que se admiten de modo genérico en la API. Por último, esta sección acaba con un recorrido por el código de un ejemplo sencillo.
Modelos de Captivate Prime
La API de Captivate Prime permite que los desarrolladores accedan a los objetos de Captivate Prime como recursos RESTful. Básicamente, eso significa que cada punto final de la API representa un recurso (en general, una instancia de objeto como una insignia o una colección de dichos objetos). Así, los desarrolladores utilizan verbos de HTTP como PUT, GET, POST y DELETE para efectuar operaciones CRUD en dichos objetos (colecciones).
En la tabla siguiente, figuran los distintos elementos del modelo de objetos de Captivate Prime.
Proceso del desarrollo de aplicaciones
Desarrollo y prueba
Obtener cuenta de desarrollador
Se recomienda que, en primer lugar, el desollador cree una cuenta de prueba en Captivate Prime, para que tenga acceso completo a todas las funciones de dicha cuenta. Asimismo, para poder escribir una aplicación, el desarrollador debe crear varios usuarios y cursos, y lograr que la cuenta tenga un estado razonable para que la aplicación que se desarrolla tenga acceso a datos ficticios.
Crear el ID de cliente y el secreto
Se explica cómo cambiar a la función de administrador de integración y registrar una aplicación nueva. Mostrar captura de pantalla y explicar varios campos
Desarrollar y probar aplicaciones
El desarrollador puede utilizar la API de Captivate Prime para crear cualquier clase de aplicación. En la fase de desarrollo, el desarrollador debe procurar que la cuenta de prueba tenga algunos usuarios y cursos. Será recomendable que el desarrollador cree algunos usuarios y cursos ficticios, y que simule actividad en la cuenta de prueba. De este modo, podrá probar el funcionamiento de la aplicación.