Documentación de la API

Aprende a conectar e integrar nuestra API.

URL base

Autenticación

Todas las solicitudes a la API requieren autenticación mediante una clave API enviada en el encabezado Authorization, como se muestra a continuación.

Authorization: Bearer {api_key}

Ejemplo

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

Errores

Nuestra API utiliza los códigos de estado HTTP habituales para indicar si una solicitud se completó correctamente o falló.

Ejemplo

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

Códigos de estado

200 Solicitud completada correctamente

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

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

404 No se encontró el recurso solicitado

429 Demasiadas solicitudes: se superó el límite permitido

500 Error interno del servidor: hay un problema de nuestro lado

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

Usuario

Enlaces

Estadísticas de enlaces

Proyectos

Píxeles

Páginas intermedias

Códigos QR

Datos

Canales de notificación

Dominios personalizados

Registros de la cuenta