Importante: Este artículo trata de información técnica relacionada con la programación. Para realizar integraciones utilizando nuestra API de integración, es esencial tener conocimientos de programación, especialmente relacionados con el protocolo de comunicación HTTP.

 

 

La API de Eadbox ofrece numerosas posibilidades de integración con todo tipo de sistemas, desde su sitio institucional, hasta un CRM, ERP o sistema académico. Pero para que usted pueda integrar nuestra plataforma con algún otro sistema, es necesario que este sistema pueda ser configurado o personalizado para recibir/enviar informaciones cuando sea necesario. Esta demanda varía mucho de negocio a negocio, entonces si desea analizar la viabilidad de una integración, siéntase a gusto para entrar en contacto con nuestro equipo técnico.

 

1. Por donde comenzar?


Usted debe poseer, para referencia, acceso a la Documentación de nuestra API (api.eadbox.com). Con ella, usted entenderá los formatos de los métodos que están disponibles para el consumo, así como el tipo de la petición HTTP que se debe enviar, y cuál es la URL de la misma. Todos los caminos se asume que ya se está accediendo a url / api desde la raíz de la plataforma.

Otras herramientas útiles son el Postman o el curl, que permiten probar los métodos de forma aislada y fácilmente replicable antes de codificar la integración en su forma final - siempre recomendamos validar los requisitos de integración de esta forma.

 

 

2. Consumiendo los métodos da API


Uno de los métodos más importantes de la API es el 2.2 (/ login). Esto se debe a que retorna en caso de éxito, la authentication_token del usuario autenticado, que puede ser utilizado para iniciar una sesión en la plataforma con el perfil del usuario informado. De esta forma, el navegador se puede dirigir a una página ya registrada, o aún se pueden llamar otros métodos de la API que se ejecutan utilizando este usuario. Sigue un ejemplo utilizando Postman:

 

 

 El retorno de la ejecución de este método es el siguiente.

 

 

Como se puede observar en este ejemplo, en caso de éxito el método devuelve el authentication_token del usuario logado, haciendo que sea posible acceder a las páginas o ejecutar otros métodos usando su perfil.

 

Para obtener la información referente a las matrículas que este usuario posee utilizando la API, por ejemplo, podemos utilizar el método 3.1 (/ user/subscriptions), de la siguiente forma (observe que el auth_token puede ser pasado como un parámetro, directamente en la URL de la petición ):

 

 

 

La ejecución del método anterior retorna un objeto JSON análogo a éste (la información anidada en "course" fue ocultada para facilitar la visualización):

 

 

 

Otro ejemplo habitual es dirigir a este usuario a la página que contiene los cursos en los que está matriculado como estudiante. Para ello, simplemente redirige el navegador a: https://apresentacao.eadbox.com/student/courses?auth_token=wNEGyV9PaYtkzoBgKuxF

 


Métodos de Administrador


Los métodos enumerados en la sección 4 de nuestra API se restringen a los usuarios con perfil de administrador solamente. Para hacer esto, basta con utilizar el método 2.2 (/ login) para obtener un auth_token de administrador, y luego informar como parámetro en las requisiciones deseadas.

Es común que se crea un usuario del grupo Administrador exclusivamente para su uso en las integraciones que requieren este tipo de permiso. Esta es una buena práctica que recomendamos, pues facilita la identificación de operaciones indebidas realizadas por una integración, por ejemplo, además de facilitar medidas de seguridad como por ejemplo la auditoria de las direcciones IP a partir de las cuales los administradores inician sus sesiones.

 

 

La documentación API de Eadbox se puede encontrar en el enlace: api.eadbox.com

 

Cualquier inquietud puedes ponerte en contacto con el departamento de soporte@eadbox.com