REST API

Aprende a integrar y utilizar la REST API de EngageLab SMS.

El servicio EngageLab SMS ofrece un conjunto de API RESTful que te permiten crear plantillas y firmas, enviar SMS y consultar el saldo de forma programática.

Sigue estos pasos para empezar a usar la REST API.

Crear una API Key

Antes de llamar a cualquier API de EngageLab SMS, debes generar una API Key para autenticar tus solicitudes.

Inicia sesión en la consola de EngageLab.
Accede a la subconsola de SMS y selecciona tu aplicación.
En la barra de navegación de la izquierda, ve a API Keys.
Haz clic en Create API Key para generar un nuevo dev_key y dev_secret.

⚠️ Advertencia
Tu dev_secret es altamente sensible. Asegúrate de guardarlo de forma segura y no lo expongas nunca en código del lado del cliente ni en repositorios públicos.

Autenticación

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

Este encabezado se construye codificando en Base64 tu dev_key y tu 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 codificando en Base64 tu dev_key y tu dev_secret unidos por dos puntos (:): base64(dev_key:dev_secret).

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

Llamar a la API

Una vez que tengas tu API Key y comprendas el mecanismo de autenticación, podrás empezar a llamar a la API. Todos los endpoints de la API utilizan la URL base https://smsapi.engagelab.com.

A continuación se presentan algunas de las principales API que puedes integrar:

Enviar SMS: envía SMS a uno o varios números de móvil de destino, con soporte para el envío automatizado de notificaciones y SMS de marketing.
Consultar saldo: consulta en tiempo real el saldo disponible de tu cuenta de EngageLab SMS a través de la API, incluyendo la información de saldo normal y saldo de regalo.
Gestión de plantillas: crea, modifica, elimina, obtén la lista completa de plantillas y consulta los detalles de una plantilla de forma programática.
Gestión de firmas: crea, modifica, elimina, obtén la lista completa de firmas y consulta los detalles de una firma de forma programática.
Referencia de eventos de callback: configura la dirección de callback y utiliza el mecanismo de verificación de seguridad para recibir informes de estado y notificaciones.
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.