Documentación de la API

Aprende cómo conectar e integrar con nuestra API.

Consigue tu propia clave API

URL base

Autenticación

Todos los puntos de acceso API requieren una clave API enviada mediante el método de autenticación Bearer.

Authorization: Bearer {api_key}

Ejemplo

curl --request GET \
--url 'https://clientesenvivo.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Nuestra API utiliza códigos de estado HTTP convencionales para indicar el éxito o fracaso de una solicitud.

Ejemplo

{
    "errors": [
        {
            "title": "No tienes acceso a la API.",
            "status": 401
        }
    ]
}

Códigos de estado

200 Solicitud completada con éxito

400 Solicitud incorrecta: faltan parámetros requeridos o son inválidos.

401 No autorizado: falta la clave de API o es inválida.

404 El recurso solicitado no fue encontrado

429 Demasiadas solicitudes - Límite de velocidad excedido

500 Error interno del servidor: esto significa que hay un problema de nuestro lado.

Todos los resultados del endpoint de la API funcionan con la zona horaria UTC a menos que se especifique lo contrario.

Usuario

Estadísticas

Campañas

Notificaciones de campaña

Manejadores de notificaciones

Registros de cuenta