Visión general de la API REST

Restricciones básicas

• La API está diseñada para ajustarse a las especificaciones de HTTP y REST. Por ejemplo, las solicitudes de consulta utilizan el método GET y las solicitudes de envío utilizan el método POST. Si una solicitud no utiliza el método HTTP correspondiente, se devolverá un error.
• A menos que se especifique lo contrario, el valor de los parámetros de llamada se debe transcodificar como UTF-8 y codificar como URL.

Límites de frecuencia de solicitudes

Nuestra API impone límites en la frecuencia de llamadas para garantizar la estabilidad y la equidad del servicio. Los límites de QPS (Queries Per Second) para cada AppKey son los siguientes:

• Límite estándar: máximo de 500 solicitudes por segundo.
• Límite avanzado: si es suscriptor de nuestro plan de pago y su AppKey de pago requiere un límite de QPS más alto, póngase en contacto con nuestro equipo comercial: Sales@engagelab.com.

Centros de datos y URL base

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

Al utilizar la API REST, 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 elegido y {API path} indica la ruta específica del endpoint de la API, por ejemplo, v4/devices/{registration_id}.

Ejemplo:

• Suponga que se selecciona el centro de datos de Singapur con una URL base de https://pushapi-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://pushapi-sgp.engagelab.com/v4/devices/{registration_id}

            

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

Con este enfoque, puede construir URL de endpoints completos para acceder a diferentes centros de datos.

Método de autenticación

La API REST de Engagelab utiliza autenticación HTTP Basic.
El enfoque básico consiste en añadir Authorization al encabezado HTTP:

              
              Authorization: Basic base64_auth_string

            

Algoritmo de generación de base64_auth_string: base64(appKey:masterSecret)
La cadena compuesta por appKey, dos puntos y masterSecret, convertida a base64.
Acceda a la página de AppPush y obtenga la información de AppKey y Master Secret en la página de información de la app (APP Info).

Ejemplo de autenticación

Su appKey es "c96f42e0d2e662e45d035ab1" y su masterSecret es "df4d59e84eac2f9d53b36f12". Para llamar a la Push API v4 mediante el comando curl, utilice el siguiente ejemplo:

              
               curl --insecure -X POST -v https://pushapi-sgp.engagelab.com/v4/push 
-H "Content-Type: application/json" 
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" 
-d '{
    "from": "push",
    "to": "all",
    "body": {
        "platform": ["android","ios"],
        "notification": {
            "alert": "Hi,MTPush !",
            "notification": {
                "alert" :"Hello, Push!",
                "android": {
                    "alert": "Hi, Push!",
                    "title": "Send to Android",
                    "builder_id": 1,
                    "extras": {
                        "newsid": 321
                    }
                },
                "ios": {
                    "alert": "Hi, MTPush!",
                    "sound": "default",
                    "badge": "+1",
                    "extras": {
                        "newsid": 321
                    }
                }
            }
        }
    },
    "request_id": "12345678",
    "custom_args": "business info"
}'

            

Ejemplo de solicitud HTTP:

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