Documentación de la API

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

Obtén tu propia clave de API

URL base

Autenticación

Todos los puntos finales de la API requieren una clave API enviada a través del método de autenticación de Bearer.

Authorization: Bearer {api_key}

Ejemplo

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

Errores

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 La solicitud se completó correctamente.

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

401 No autorizado - la clave de API está ausente o no es válida

404 El recurso solicitado no se encontró

429 Demasiadas solicitudes: límite de velocidad excedido

500 Error interno del servidor - esto significa que hay un problema en 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

Enlaces

Estadísticas de enlaces

Proyectos

Píxeles

Páginas de bienvenida

Códigos QR

Datos

Notification handlers

Dominios personalizados

Pagos de cuenta

Registros de cuenta