Descripción general de la API REST

Básico

• La API está diseñada para cumplir las especificaciones de HTTP y REST. Por ejemplo, el método GET se utiliza para solicitudes de consulta y el método POST se utiliza para solicitudes de envío. Si una solicitud no utiliza el método HTTP correspondiente, se devuelve un error.
• Salvo que se indique lo contrario, el valor del parámetro de la llamada debe codificarse en UTF-8, Codificación de URL (URL Coding)

Centros de datos y URL base

A partir del 19 de marzo de 2025, se solicita a los desarrolladores que accedan por primera vez a la Engagelab Push API que utilicen el siguiente nombre de dominio. La URL base original con el sufijo .cc puede seguir utilizándose, pero se recomienda cambiar al nombre de dominio más reciente.

Al utilizar la REST API, es necesario combinar la URL base seleccionada con la ruta específica de la API para obtener el endpoint completo.

              
              {base URL}/{API path}

            

Aquí, {base URL} representa la URL base del centro de datos seleccionado y {API path} denota la ruta del endpoint específico de la API, como v4/devices/{registration_id}.

Ejemplo:

• Si se selecciona el centro de datos de Singapur con una URL base de https://webpushapi-sgp.engagelab.com.
• Si el objetivo es eliminar la información de registro de un dispositivo específico y la ruta de la API es v4/devices/{registration_id}, entonces el endpoint completo de la API sería:

              
              https://webpushapi-sgp.engagelab.com/v4/devices/{registration_id}

            

Aquí, {registration_id} representa el ID de registro del dispositivo específico.

Con este enfoque, se pueden construir URL de endpoint completas de la API para acceder a diferentes centros de datos.

Método de autenticación

La Engagelab REST API utiliza autenticación básica HTTP (HTTP basic authentication)
El método básico consiste en añadir el encabezado HTTP Authorization (Header):

              
              Authorization: Basic base64_auth_string

            

El algoritmo de generación de base64_auth_string es base64(appKey:masterSecret)
Es decir, se añaden dos puntos a la appKey, se concatena el masterSecret a la cadena ensamblada y, a continuación, se realiza la conversión a base64
Se puede acceder a los parámetros appKey y masterSecret en Configuración de la aplicación > Información de la aplicación

Ejemplo de autenticación

Si su appKey es "c96f42e0d2e662e45d035ab1" y el masterSecret es "df4d59e84eac2f9d53b36f12", al llamar a la Push API v4 se puede utilizar el comando curl siguiente:

              
               curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/push 
-H "Content-Type: application/json" 
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" 
-d '{"from":"push","to":"all","body":{"platform":"web","notification":{"alert":"Hi,MTPush !","web":{"alert":"Hi,MTPush !", "title":"web_push", "url":"http://www.google.com","extras":{"web-key1":"web-value1"}}}},"request_id":"12345678", "custom_args":"business info"}'

            

La solicitud HTTP es:

              
              > POST /v4/push HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==