Documentación API

Esta es la documentación para los puntos finales API disponibles, que se basan en la arquitectura REST. Todos los puntos finales de API devolverán una respuesta JSON con los códigos de respuesta HTTP estándar y necesitarán una autenticación de portador a través de una clave API.

 

Autenticación

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

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

Errores

Nuestra API utiliza códigos de estado HTTP convencionales para indicar si una solicitud se ha realizado correctamente o no.

{
    "errors": [
        {
            "title": "No tienes acceso a la API.",
            "status": 401
        }
    ]
}
200 Solicitud completada exitosamente
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 de solicitudes.
500 Error interno del servidor: esto significa que hay un problema de nuestra parte.
Todos los resultados de los puntos finales de la API funcionan con la zona horaria UTC a menos que se especifique lo contrario.
Usuario
Links
Estadísticas de links
Proyectos
Códigos QR
Datos
Controlador de notificaciones
Dominios personalizados
Registros de cuenta