Documentación de API

Esta es la documentación de los puntos finales de API disponibles, que están construidos alrededor de la arquitectura REST. Todos los puntos finales de API devolverán una respuesta JSON con los códigos de respuesta HTTP estándar y necesitan autenticación Bearer a través de una clave de API.

 

Autenticación

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

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

Errores

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

{
    "errors": [
        {
            "title": "No tienes acceso a la API.",
            "status": 401
        }
    ]
}
200 Solicitud completada exitosamente
400 Solicitud incorrecta: faltan parámetros requeridos o son inválidos
401 No autorizado: la clave API falta 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 de puntos finales de API funcionan con la zona horaria UTC a menos que se especifique lo contrario.
Usuario
Enlaces
Estadísticas e Informes
Proyectos
Píxeles
Páginas de presentación
Códigos QR
Firmas
Datos
Controladores de notificaciones
Dominios personalizados
Equipos
Miembros del equipo
Miembro de los equipos
Pagos de cuenta
Registros de cuenta