REST API

Aprenda a integrar y usar la REST API de EngageLab OTP.

El servicio OTP de EngageLab ofrece un conjunto de API RESTful que le permiten crear plantillas, enviar OTP y verificar códigos de verificación mediante programación.

Siga estos pasos para empezar a usar la REST API.

Crear una API Key

Antes de llamar a cualquier API de EngageLab OTP, debe generar una API Key para autenticar sus solicitudes.

Inicie sesión en la consola de EngageLab.
Entre en la subconsola de OTP y seleccione su aplicación.
En la barra de navegación de la izquierda, vaya a API Keys.
Haga clic en Create API Key para generar un nuevo dev_key y dev_secret.

⚠️ Advertencia
Su dev_secret es muy sensible. Consérvelo de forma segura y no lo divulgue nunca en el código del cliente ni en repositorios de código públicos.

Autenticación

La API OTP de EngageLab utiliza la autenticación HTTP Basic. Debe incluir el encabezado Authorization en todas las solicitudes a la API.

Este encabezado se construye codificando en Base64 su dev_key y su dev_secret:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Este bloque de código se muestra en una ventana flotante

${base64_auth_string} se genera concatenando su dev_key y su dev_secret mediante dos puntos (:) y codificando el resultado en Base64: base64(dev_key:dev_secret).

Para más detalles, consulte la guía de Autenticación.

Llamar a la API

Una vez que disponga de la API Key y comprenda el mecanismo de autenticación, podrá empezar a llamar a la API. Todos los endpoints de la API usan la URL base https://otp.api.engagelab.cc.

A continuación se indican varias de las API principales que puede integrar:

Envío de OTP: genera el código de verificación a través de la plataforma EngageLab y lo envía según la estrategia de su plantilla.
Verificación de OTP: verifica de forma segura la contraseña de un solo uso (código de verificación) enviada por el usuario.
Envío de OTP personalizado: si desea generar el código de verificación por su cuenta, puede enviar al usuario un código de verificación pregenerado.
Envío de mensajes personalizados: envía contenido de mensaje creado a partir de una plantilla personalizada (por ejemplo, notificaciones o mensajes de marketing).
Gestión de plantillas: crea, elimina, obtiene la lista de todas las plantillas y consulta los detalles de las plantillas mediante programación.
Configuración de callbacks: configura la dirección de callback y utiliza mecanismos de verificación de seguridad para recibir informes de estado y notificaciones.
Callback de estado del ciclo de vida: recibe mediante callbacks, en tiempo real, los datos de cada estado del ciclo de vida del mensaje (envío, entrega, verificación, etc.).
SMPP: utiliza el protocolo SMPP para lograr un envío de mensajes y un reporte de estado eficientes y fiables a través de una conexión TCP.