Este artículo también está disponible en:
Este artículo está traducido utilizando un traductor automático. Podría contener algunos errores o traducciones extrañas. De todos modos, creemos que es valioso que puedas leer este artículo de ayuda en tu idioma materno. Déjanos tu comentario al final del artículo si este artículo te resultó útil o si tienes algún otro comentario.

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

1. ¿Qué es la API?

API son las siglas de Interfaz de programación de aplicaciones. Es la interfaz que permite a las aplicaciones de software comunicarse entre sí. Básicamente, 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 haberle proporcionado información

Ejemplo 1

Cuando vas a Facebook en tu navegador, se envía una solicitud 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 cliente, el servidor de Facebook es una API. Esto significa que cada vez que visitas una página en la web, interactúas con alguna API del servidor remoto.

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

Ejemplo 2

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 enlace crítico para comunicar su pedido a la cocina y entregar su comida a su mesa. Ahí es donde entra 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 URLs dedicadas que devuelven respuestas de datos puros, es decir las respuestas no contienen el tipo de sobrecarga de presentación que se espera en una interfaz gráfica de usuario como un sitio web.

2. ¿Para qué lo utilizo?

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

La ventaja para el sitio anfitrión es que obtiene un montón de nuevas y geniales características de forma gratuita, mientras que los desarrolladores consiguen promocionar su trabajo en un sitio de mayor perfil y construir sobre el trabajo de otros. La mayoría de estas aplicaciones son creadas por empresas con su propio sitio web, a menudo pequeñas empresas con menos tráfico que se benefician del cruce. El sitio de críticas de películas Flixster, por ejemplo, tiene una popular aplicación en Facebook, al igual que Last.fm y el sitio para compartir fotos Flickr.

3. ¿Qué llamadas a la API tiene Easy LMS?

Tenemos seis llamadas a la API que sirven para diferentes funciones:

Añadir participante a Examen (invitar)
Añadir un participante a Examen sin notificarlo (sin invitación)
Añadir participante a Curso (invitar)
Añadir participante a Academia (invitar)
Añadir un participante a Academia sin notificarlo (sin invitación)
Eliminar participante (elimina todos los datos del participante de nuestro sistema de forma permanente)

Las llamadas a la API para un Examen sólo funcionan cuando el acceso está configurado para Un grupo predefinido de participanteso para un Curso que es Sólo por invitación. Esto se explica por sí mismo en el caso de 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 a la API consta de 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 de error)

La carga útil es la información que se envía a un punto final, es decir, los datos necesarios para añadir/borrar 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 con éxito o no.

Webhooks

Los webhooks se pueden utilizar junto con las llamadas a la 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, ésta hará su trabajo y añadirá/eliminará al participante. Los webhooks deben ser enviados desde su sistema a nuestro endpoint. Esto es algo que tendría que configurar usted mismo en su sistema.

Ejemplo 1 - Curso, Examen, Academia

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

Un director de RRHH ha creado un nivel de entrada Curso y Examen para los empleados recién contratados. El director de RRHH 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 quiere que los empleados tengan acceso al Academia, que contiene los niveles intermedio y experto Cursos y Exámenes. Entonces, ¿cómo se configura esto?

Para entender cómo configurar esto ya hemos establecido que estos webhooks y llamadas a la 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 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 Examen. En este caso, utilizamos la función Añadir participante a Examen (invitar) API. 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 a Examen automáticamente.

El segundo webhook que el responsable de RRHH debe crear es para cuando el empleado pasa el Examen con éxito para acceder al Academia. De nuevo, la carga útil de este webhook sólo debe contener la información que la llamada a la API Academia necesita para añadir al participante y enviar una invitación. Después de enviar este webhook ''Examen aprobado'', se activará la llamada a la API Academia, tras lo cual añade al participante y envía una invitación para el Academia.

En resumen

Crear webhook para la finalización de Curso que se envía a la llamada de la API Examen.
Crear webhook para pasar Examen que se envía a la llamada API Academia.
El empleado toma Curso y lo completa.
El webhook para completar Curso se envía a Añadir participante a Examen (invitar) El punto final de la llamada API añade e invita al participante a Examen.
El empleado toma Examen y lo pasa
Webhook para pasar Examen se envía a Añadir participante a Academia (invitar) Llamada al punto final de la API y añade e invita al participante a Academia.



Ejemplo 2 - Envío de invitaciones desde su propio sistema

Un cliente quiere utilizar nuestra herramienta para la formación de sus (nuevos) empleados. Actualmente utilizan el sistema 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 crea primero un webhook que envía una carga útil a la API de exámenes: añadir un participante sin notificarlo. Cuando se añade un nuevo empleado a su sistema, el webhook envía la carga útil a la API 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 tiene éxito, la respuesta incluye las credenciales de inicio de sesión. Estas credenciales de acceso deben ser enviadas 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 Examen que desencadene la acción de añadir participantes sin notificar a la 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 Exámenes

Un cliente crea 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 venta necesitará 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 crea debe activarse después de que hayan pagado. Este webhook enviará entonces la carga útil correspondiente a la llamada a la API 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 a la página Examen por la que han pagado.



5. ¿Cuáles son las especificaciones de las llamadas a la API?

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

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

Llamadas a la API para Exámenes y Academia

Llamada a la API para Cursos

API de eliminación de participantes
¿Este artículo te resultó útil?
Cancelar
¡Gracias!