RestAPI Overview

Restricciones básicas

  • La API está diseñada para cumplir con las especificaciones HTTP y RESTful. Por ejemplo, se utiliza el método GET para las solicitudes de consulta y el método POST para las solicitudes de envío. Si una solicitud no utiliza el método HTTP correspondiente, se devolverá un error.
  • Salvo que se especifique lo contrario, los parámetros deben codificarse en UTF-8 y debe aplicárseles la codificación de URL.

Centros de datos y URL base

Centro de datos URL base
Singapur https://ma-api.engagelab.com
Virginia, EE. UU. https://ma-api-usva.engagelab.com

Al utilizar la API REST, se debe combinar la URL base seleccionada con la ruta específica de la API para obtener la URL de llamada completa.

{base URL}/{API path}
              
              {base URL}/{API path}

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

Método de autenticación

La API REST de EngageLab utiliza el método de autenticación HTTP Basic Authentication: añadir Authorization a la cabecera HTTP:

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}

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

El valor base64_auth_string se genera mediante el siguiente algoritmo: base64(api_key:api_secret).

  • El nombre de la cabecera es "Authorization" y el valor es el par "nombre_de_usuario:contraseña" codificado en base64 (con dos puntos en medio).
  • Para la API de MA, el nombre de usuario corresponde a la API Key y la contraseña corresponde al API Secret. Se debe configurar una fuente de datos de tipo API para obtener la API Key y el API Secret.
icon
Contacto