Introducción
A menudo, para automatizar determinados flujos de usuario es necesario realizar integraciones via una Application Program Interface (API).
Toda API debe estar protegida mediante algun mecanismo. Para lograr una comunicacion segura y autorizada entre aplicaciones o también conocido como integración Server-to-Server, se utilizan las claves de API o API Key.
Gestion de API Key
Creación de API Key
Para crear una API Key en una academia de go4clic debemos seguir los siguientes pasos.
1. Nos dirigimos a la seccion Integraciones > Claves de API > + Agregar
2. Le damos un nombre para identificar la integración y la guardamos
3. Hacemos clic en la clave para copiarla al portapapeles y llevarla a la otra plataforma que deseamos integrar.
IMPORTANTE: cabe notar que por temas de seguridad la clave se visualiza una unica vez. Una vez que se cierre esta ventana no podrémos saber esta información y deberemos crear una nueva.
Utilización de API Key
Para que una aplicación tercera pueda realizar peticiones de integración a la API de go4clic en nombre de la academia donde la hemos creado, deberemos especificar un parametro x-api-key
como header de la peticion HTTP
.
Casos de uso
Enrolar persona en una formación, incluso a traves de Zapier o Pabbly Connect
Creación de access token para un usuario e implementar el flujo de autologin
Alta de persona en una academia
Obtención datos del dashboard