Documentación de la API

Esta es la documentación de los endpoints de la API disponibles, construidos con arquitectura REST. Todos los endpoints de la API devuelven una respuesta JSON con códigos de respuesta HTTP estándar y requieren autenticación Bearer mediante una clave de API.

 
Obtén tu propia clave de API

Autenticación

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

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

Erros

Nuestra API usa códigos de status HTTP convencionais para indicar o sucesso o a falha de una requisição.

{
    "errors": [
        {
            "title": "No tiene acceso a la API.",
            "status": 401
        }
    ]
}
200 Solicitud completada correctamente
400 Solicitud no válida: parámetros obligatorios ausentes o no válidos
401 No autorizado: a clave de API está ausente o es no válida
404 O recurso solicitado no fue encontrado
429 Muitas requisições: límite de requisições excedido
500 Erro interno del servidor: esto significa que há un problema del nuestro lado
Todos los resultados del endpoint de la API funcionam con el fuso hora UTC a menos que sea especificado de otra forma.
Usuario
Enlaces
Estadísticas de enlaces
Proyectos
Pixels
Páginas de introducción
Códigos QR
Assinaturas
Fecha
Notificaciones
Dominios personalizados
Minhas equipes
Miembros de el equipo
Membro de el equipo
Registros de la cuenta