Este artículo también está disponible en:
Aquí explicamos todo sobre (nuestra) API con algunos ejemplos agradables, cómo puedes usarla y por qué deberías usarla.

1. ¿Qué es el API?

API significa Interfaz de programación de aplicaciones. Es la interfaz que permite que las aplicaciones de software se comuniquen entre sí. Básicamente permite solicitar algo, o hacer una pregunta, después de lo cual la llamada a la API realiza la acción que se supone que debe hacer, después de que usted le haya proporcionado información. En nuestro caso se trataría de pedir que se añada un participante a un examen, un curso o la academia que requiere datos específicos sobre el participante.

Ejemplo 1

Cuando vas a Facebook en tu navegador, una solicitud va al servidor remoto de Facebook. Una vez que tu navegador recibe la respuesta, interpreta el código y muestra la página.

Para el navegador, también conocido como el cliente, el servidor de Facebook es una API. Esto significa que cada vez que visitas una página en la Web, interactúas con la API de algún servidor remoto.

Una API no es lo mismo que el remoto - rather server  es la parte del servidor que recibe las solicitudes y envía las respuestas.

Ejemplo 2

Imagina que estás sentado en una 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 vínculo crítico para comunicar su pedido a la cocina y entregar su comida a su mesa. Ahí es donde entra el camarero o el API. El camarero es el mensajero - o API - que toma su solicitud o pedido y le dice a la cocina - el sistema - lo que debe hacer. Luego el camarero le 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 datos puros responses - meaning las respuestas no contendrán el tipo de gastos generales de presentación que cabría esperar en una interfaz gráfica de usuario como un sitio web.

2. ¿Para qué lo uso?

Los desarrolladores pueden usar diferentes APIs de diferentes maneras para construir cosas diferentes. Facebook es un buen ejemplo; el sitio lanzó su plataforma para desarrolladores llamada F8 en mayo y ahora alberga la asombrosa cantidad de 10.900 aplicaciones, desde el infame Scrabulous hasta la mensajería instantánea y los juegos de lucha contra la comida.

La ventaja para el sitio anfitrión es que obtiene muchas características nuevas y geniales de forma gratuita, mientras que los desarrolladores consiguen promover su trabajo en un sitio de más alto perfil y construir sobre el trabajo de otra persona. La mayoría de estas aplicaciones son construidas por compañías con su propio sitio web - a menudo negocios más pequeños con menos tráfico que se benefician del cruce. El sitio de reseñas de películas Flixster, por ejemplo, tiene una aplicación popular en Facebook, al igual que Last.fm y el sitio para compartir fotos Flickr.

3. ¿Qué llamadas API tiene Easy LMS?

Easy LMS tiene cinco llamadas API que sirven para diferentes funciones:

Añadir el participante a Examen (invitación)
Añadir el participante a Examen sin notificar (sin invitación)
Agregar participante a Curso (invitación)
Agregar participante a Academia (invitación)
Agregar participante a Academia sin notificar (sin invitación)

La API exige que un examen sólo funcione cuando el acceso se establece en Un grupo predefinido de participantes, o para un curso que es sólo por invitación. Esto se explica por sí mismo para la Academia. Tampoco es posible utilizar ninguna de estas llamadas para el mismo Examen, Curso o Academia cuando ya se ha añadido un participante. Esto se debe a que el objetivo de estas llamadas a la API es añadir participantes, por lo que si ya han sido añadidos, la llamada a la API no funciona.

Una llamada al API consiste en tres cosas:

La carga útil (los datos reales que se envían)
El punto final (la dirección a la que se envían los datos)
La respuesta (respuesta de éxito o error)

La carga útil es la información que se envía a un punto final, lo que significa que los datos son necesarios para añadir un participante al examen, al curso o a la academia.

El punto final es una dirección web a la que se envía la información, y la respuesta indica si la llamada a la API tuvo éxito o no.

4. Webhooks

Los ganchos web pueden ser usados en conjunto con las llamadas al API para iniciar diferentes acciones. Cuando se envía un webhook que contiene la carga útil necesaria para que funcione una determinada llamada a la API, la llamada a la API hará su trabajo y añadirá al participante. Los webhooks deben ser enviados desde su sistema a nuestro punto final. Esto es algo que tendrías que configurar tú mismo en tu sistema.

Ejemplo 1 - Curso, Examen, Academia

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

Un gerente de RRHH ha creado un curso y un examen de entrada para los empleados recién contratados. El gerente de RRHH quiere que los empleados tomen el Curso, pero sólo quiere que accedan al Examen después de completar el Curso. Sólo después de aprobar el Examen quiere que los empleados tengan acceso a la Academia, que contiene Cursos y Exámenes de nivel intermedio y experto. Así que, ¿cómo lo establecen?

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

El gerente de RRHH tiene que crear un webhook que envía una carga útil a la API del examen 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 del examen. En este caso, utilizamos la llamada a la API Agregar participante al examen (invitación). Cuando se haya enviado este webhook, la llamada a la API se activará si hay una respuesta positiva. La llamada a la API añade al participante y envía la invitación al examen automáticamente.

El segundo webhook que el director de RRHH debe crear es para cuando el empleado pase el examen con éxito para acceder a la Academia. Una vez más, la carga de este webhook sólo debe contener la información que la llamada a la API de la Academia necesita para agregar al participante y enviar una invitación. Después de enviar este webhook ''Examen aprobado'', se activará la llamada a la API de la Academia, tras lo cual añade al participante y envía una invitación para la Academia.

Para resumir:

Crear un webhook para completar el curso que se envía a la llamada del API del examen.
2. Crear webhook para aprobar el examen que se envía a la llamada de la API de la Academia.
El empleado toma el curso y lo completa.
4. Webhook para completar el Curso se envía a Agregar el participante al Examen (invitación) API llamada final y agrega e invita al participante al Examen.
El empleado toma el Examen y lo aprueba.
6. Webhook para pasar el Examen se envía a Agregar participante a la Academia (invitación) API llamada punto final y agrega e invita al participante a la Academia.



Ejemplo 2 - Enviando invitaciones desde su propio sistema

Un cliente quiere usar nuestra herramienta para entrenar 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 terminan en sus carpetas de spam. El cliente quiere enviar estas invitaciones desde su propio sistema.

El cliente primero crea un webhook que envía una carga útil a la API de examen - añadir el participante sin notificar a. Cuando un nuevo empleado es añadido al sistema, el webhook envía la carga a la API de examen que añade al empleado. La llamada a la API no envía una invitación a este empleado. Cuando la llamada a la API se realiza con é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 hay que crear un webhook que envía una carga útil a la API del examen que desencadena 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 entonces desde su propio sistema.

Ejemplo 3 - Venta de exámenes

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

Para automatizar su proceso de ventas necesitará usar un webhook. Cuando sus clientes compran o pagan por un examen en su sitio web de comercio electrónico, se agregan a su sistema. El webhook que crea debe ser activado después de que hayan pagado. Este webhook enviará entonces la carga relevante a la llamada de la API del examen y debe devolver una respuesta de éxito o de error. Si la respuesta es satisfactoria, la llamada a la API añade e invita a sus clientes al examen por el que han pagado.



5. ¿Cuándo usamos cada una de las llamadas de la API y cuáles son sus especificaciones?

Como cada llamada a la API tiene una función diferente, se pueden utilizar para lograr cosas diferentes. Por ejemplo, Añadir participante al examen (invitación) puede utilizarse para añadir un participante y enviar una invitación para un examen automáticamente cuando se activa este activador.

Nuestra API acepta datos de aplicación/x-www-form-urlencoded o multiparte/form-data y json.

Para más información sobre los exámenes y las llamadas al API de la Academia, consulte este artículo.

Para saber más sobre nuestro curso API, llama a este artículo.
¿Este artículo te resultó útil?
Cancelar
¡Gracias!