Este artículo es para principiantes que pretende fundamentar las principales particularidades de la API de Eadbox. Con el conocimiento en manos, junto a conocimientos de programación será posible crear automatizaciones e integraciones de sistemas externos a Eadbox, nuestro sistema.

 

 

Paso a paso


Nuestra API se divide en tres partes principales, cada una con su respectivo niveles de permisos y acceso a métodos diferentes: Métodos públicos, métodos de alumno y métodos de administración. Al igual que el acceso a nuestra plataforma, cada perfil tiene sus respectivos permisos.

  • Público: Métodos que no requieren autenticación, son métodos de creación de usuario, métodos de inicio de sesión, y métodos de lista de información que son públicos en la plataforma (como cursos disponibles, por ejemplo).

  • Alumno: Métodos respectivos al perfil del alumno que los ejecuta, como por ejemplo el listado de cursos en el cual este alumno está matriculado y cuál es su estado de visualización en una determinada clase.

  • Administrador: Métodos de gestión de la plataforma, donde es posible realizar operaciones en varias partes de la plataforma, crear cursos y módulos, listar pagos, entre otras funciones..

 

La clave principal para la autenticación en la plataforma se denomina "auth_token", y es un string de caracteres únicos para cada usuario. Esta string se renueva de vez en cuando, y para perfiles de administrador, no expiran.

Al utilizar la clave de autenticación de un perfil para realizar una llamada de la API, todas las funciones ejecutadas en la plataforma se realizarán como si el perfil estuviera ejecutando tal acción.

.

Como obtener el auth_token de un perfil?


Hay dos formas de extraer la clave de autenticación de un perfil: Vía login y via  lista de usuarios con perfil de administrador. Hay algunas características a ser notadas antes de la ejecución de cualquier método:

 

  • Todos los métodos deben seguir el siguiente formato: url_da_sua_plataforma.eadbox.com + /api/ + método + ? + parámetro=valor + & + parametro=valor.

  • Toda lista de API debe contener /api después de la url de la plataforma.

  • Parámetros son pasados después del método, después de un "?"

  • Parámetros son pasados en el  siguiente formato: parámetro=valor

  • Para casos donde hay más de un parámetro, encadenar con el carácter "&" entre cada uno.

 

Sabiendo esto, para obtener un auth_token, basta realizar  lo siguiente: 


  • Login: Tener a mano la URL de la plataforma, login y contraseña válidos luego ejecutar un pedido de tipo POST pasando como parámetro en la URL el login y contraseña conforme el siguiente ejemplo.


https://SUA-PLATAFORMA.eadbox.com/api/login?email=testeapi@eadbox.com&password=123456

El retorno es un objeto en el formato JSON, conforme el siguiente ejemplo:

 


 

    Note el campo "authentication_token", el valor de este campo es la llave de autenticación para el usuario que fue logueado.

 

Los métodos de alumno y los métodos de administrador requieren la presencia de un token de autenticación de un perfil de ese tipo para la ejecución de cualquier método. Para insertar el auth_token de un perfil como parámetro, basta con seguir el siguiente ejemplo:

 

https://SUA-PLATAFORMA.eadbox.com/api/MÉTODO?auth_token=zx6QK5M1wxSwaKMr0000

 

  • Administrativo: Teniendo en manos el auth_token de un administrador, para la extracción de los auth_token de todos los alumnos basta la ejecución de una petición GET como el siguiente ejemplo:


https://SUA-PLATAFORMAcom/api/admin/users?auth_token=zx6QK5M1wxSwaKMr0000&page=1

El retorno es un conjunto de 100 objetos JSON, de acuerdo con la numeración. Cada objeto sigue el siguiente ejemplo:

 

 

 

 

 

Observe la presencia nuevamente del auth_token, para aquel perfil de la plataforma.


Para casos donde la petición devuelve un conjunto de datos mayor que 100 los datos serán enumerados. Para acceder a nuevas páginas, simplemente introduzca el parámetro "page =" y el número de la página que desea acceder a la url.

 

 

Diferencia entre auth_token y user_ID: Todo usuario más allá de su llave de autenticación, tiene su id. Este id es una cadena única identificadora dentro de la plataforma, y todas las operaciones a realizar para ese usuario se deben hacer utilizando este valor. La diferencia primordial entre auth_token y user_id es que el token es para la AUTENTICACIÓN de acceso y permisos del usuario en la plataforma, y el id se utiliza para la ejecución de métodos para el usuario.

 

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