Aquí te explicamos todo sobre (nuestra) API con algunos buenos ejemplos, cómo puedes usarla y por qué deberías usarla.

API significa Interfaz de Programación de Aplicaciones. Es la interfaz que permite a las aplicaciones de software comunicarse entre sí. Básicamente te permite solicitar algo o hacer una pregunta, tras lo cual la llamada a la API realiza la acción que se supone que debe hacer, después de que le hayas proporcionado información.

Imagina que estás sentado en la mesa de un restaurante con un menú de opciones para pedir. La cocina es la parte del "sistema" que preparará su pedido. Lo que falta es el eslabón crítico para comunicar su pedido a la cocina y llevar la comida a su mesa. Ahí es donde entra en juego el camarero, o API. El camarero es el mensajero -o API- que recibe tu solicitud o pedido y le dice a la cocina -el sistema- lo que tiene que hacer. A continuación, el camarero te devuelve la respuesta; en este caso, es la comida.

En resumen, cuando una empresa ofrece una API a sus clientes, sólo significa que ha creado un conjunto de URL dedicadas que devuelven respuestas de datos puros, lo que significa que las respuestas no contendrán el tipo de sobrecarga de presentación que cabría esperar en una interfaz gráfica de usuario como un sitio web.

Tenemos cinco llamadas API que sirven para diferentes funciones.

Una llamada API consta de tres elementos:

La carga útil es la información que se envía a un punto final, es decir, los datos necesarios para añadir un participante.

El endpoint es una dirección web a la que se envía la información, y la respuesta indica si la llamada a la API se ha realizado correctamente o no.

Los webhooks pueden utilizarse junto con las llamadas a la API para iniciar distintas acciones. Cuando se envía un webhook que contiene la carga útil necesaria para que funcione una determinada llamada API, la llamada API hará su trabajo y añadirá al participante. Los webhooks deben ser enviados desde su sistema a nuestro endpoint y tienen que ser configurados por usted mismo en su sistema.

Los siguientes párrafos forman parte de un caso de uso ficticio para explicar cómo pueden trabajar juntos los webhooks y las API.

Un director de RRHH ha creado un curso y un examen de nivel inicial para los empleados recién contratados. El director de RR.HH. quiere que los empleados realicen el curso, pero sólo quiere que accedan al examen después de completar el curso. Sólo después de aprobar el examen quieren que los empleados tengan acceso a la academia, que contiene cursos y exámenes de nivel intermedio y experto. Entonces, ¿cómo se configura esto?

Para entender cómo configurar esto, ya hemos establecido que estos webhooks y llamadas API se enviarán internamente dentro del sistema Easy LMS. El proceso es el siguiente.

El responsable de RRHH tiene que crear un webhook que envíe una carga útil a la API de exámenes después de que el empleado complete el curso. Este webhook sólo tiene que contener los datos necesarios para activar la llamada a la API de exámenes. En este caso, utilizamos la llamada a la API Añadir participante a examen (invitar). Cuando se haya enviado este webhook, la llamada a la API se activará si hay una respuesta satisfactoria. La llamada a la API añade el participante y envía la invitación al examen automáticamente.

El segundo webhook que el responsable de RR.HH. debe crear es para cuando el empleado aprueba el examen con éxito para acceder a la academia. De nuevo, la carga útil de este webhook sólo debe contener la información que la llamada a la API de la academia necesita para añadir al participante y enviar una invitación. Tras enviar este webhook, se activará la llamada a la API de la academia, tras lo cual añadirá al participante a la academia y enviará una invitación.

Resumiendo:

Un cliente desea utilizar nuestra herramienta para formar a sus (nuevos) empleados. Actualmente utilizan la configuración Un grupo predefinido de participantes para enviar correos electrónicos de invitación. Sin embargo, muchos empleados perciben estas invitaciones como spam, y algunos de estos correos electrónicos también acaban en sus carpetas de spam. El cliente desea enviar estas invitaciones desde su propio sistema.

El cliente crea primero un webhook que envía una carga útil a la API de Examen - añadir participante sin notificar. Cuando se añade un nuevo empleado a su sistema, el webhook envía la carga útil a la API de exámenes que añade al empleado. La llamada API no envía una invitación a este empleado. Cuando la llamada a la API tiene éxito, la respuesta incluye las credenciales de inicio de sesión. Estas credenciales de inicio de sesión deben enviarse al empleado desde su propio sistema y aplicación de correo.

Esto también funciona para los empleados existentes, sólo tiene que crear un webhook que envíe una carga útil a la API de exámenes que desencadene la acción de añadir participantes sin notificar al examen. Las credenciales de inicio de sesión devueltas en la respuesta de la llamada a la API pueden enviarse desde su propio sistema.

Un cliente crea exámenes en nuestro sistema y los vende a sus propios clientes desde su sitio web de comercio electrónico. Desean automatizar este proceso después de que los clientes paguen por un examen.

Para automatizar el proceso de venta necesitarán utilizar un webhook. Cuando sus clientes compran o pagan un examen en su sitio web de comercio electrónico, se añaden a su sistema. El webhook que creen debe activarse después de que hayan pagado. Este webhook enviará entonces la carga útil correspondiente a la llamada a la API de exámenes y debe devolver una respuesta de éxito o de error. Si la respuesta es correcta, la llamada a la API añade e invita a los clientes al examen por el que han pagado.
​

Nuestra API acepta application/x-www-form-urlencoded o multipart/form-data y json.

Obtenga más información en los siguientes artículos: