Descripción general de la API REST
Restricciones básicas
- La API está diseñada para cumplir las especificaciones de HTTP y REST. Por ejemplo, las solicitudes de consulta usan el método GET y las solicitudes de envío usan el método POST. Si una solicitud no usa el método HTTP correspondiente, se devuelve un error.
- Salvo indicación en contrario, los valores de los parámetros deben codificarse en UTF-8, codificación de URL (URL encoding).
Centro de datos y URL base
| Centro de datos | URL base |
|---|---|
| Singapur | https://livedesk-api.engagelab.com |
Al usar la API REST, se debe combinar la URL base seleccionada con la ruta específica de la API para obtener la dirección completa de la llamada.
{base URL}/{API Path}
{base URL}/{API Path}
Este bloque de código se muestra en una ventana flotante
Autenticación
La API REST de EngageLab usa la autenticación básica HTTP (HTTP Basic Authentication); se añade Authorization al encabezado HTTP:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Este bloque de código se muestra en una ventana flotante
El algoritmo para generar el valor anterior de base64_auth_string es: base64(api_key:api_secret)
- El nombre del encabezado es "Authorization" y el valor es el par "username:password" codificado en Base64 (separado por dos puntos).
- En el contexto de la API de LiveDesk, el nombre de usuario es la API Key y la contraseña es la API Secret. Se debe añadir una fuente de datos de tipo API en "Project Settings - API Management" para obtener la API Key y la API Secret.
