Documentación de la API

Aprende a conectarte e integrarte con nuestra API.

Obtén tu propia clave de API

URL base

Autenticación

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

Authorization: Bearer {api_key}

Ejemplo

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

Nuestra API utiliza códigos de estado HTTP convencionales para indicar si una solicitud se ha realizado con éxito o ha fallado.

Ejemplo

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

Códigos de estado

200 La solicitud se completó correctamente

400 Solicitud incorrecta: faltan parámetros obligatorios o no son válidos

401 No autorizado: falta la clave de API o no es válida

404 No se encontró el recurso solicitado

429 Demasiadas solicitudes: se ha superado el límite

500 Error interno del servidor: significa que hay un problema por nuestra parte

Todos los resultados de los endpoints de la API usan la zona horaria UTC, salvo que se indique lo contrario.

Usuario

Estadísticas

Campañas

Notificaciones de la campaña

Canales de notificación

Pagos de la cuenta

Registros por referido

Registros de la cuenta