Primeros pasos
Gestiona vídeos, cargas, archivos, pruebas A/B y dominios de VTurb por REST
La API de VTurb es una API REST pública para tu cuenta de VTurb. Cada respuesta documentada se registró a partir del comportamiento real de la API.
URL base
https://api.vturb.comTodas las rutas empiezan con /v1.
Autenticación
Envía tu token de la API de VTurb (vt_...) como token bearer en cada solicitud:
curl https://api.vturb.com/v1/videos \
-H "Authorization: Bearer vt_..."Cada acción requiere un scope en el token: videos:read, videos:upload y videos:write para vídeos, ab_tests:read y ab_tests:write para pruebas A/B, domains:read y domains:write para dominios.
- Un token ausente o inválido devuelve
unauthorized. - Un token sin el scope que requiere la acción devuelve
forbidden. - Una organización que no está habilitada para la API devuelve
org_not_enabled.
Errores
Los errores son cuerpos application/problem+json con los mismos cuatro campos. code identifica el error y type enlaza a su página en Errores:
{
"type": "https://docs.vturb.com/errors/not_found",
"code": "not_found",
"message": "Resource not found.",
"request_id": "0b5e7a1c-9f3d-4c2b-8e1a-7d6c5b4a3f21"
}Listas
Los endpoints de listado aceptan los parámetros de consulta cursor y per_page para la paginación por cursor.
Actualizar un vídeo
PATCH /v1/videos/{id} es un merge-patch: envía solo lo que quieres cambiar y todo lo demás conserva su valor guardado. Cómo funciona el merge-patch explica las reglas, y cada funcionalidad tiene su propia guía.
Devuelve el uso en tiempo real de la cuota de la API de la empresa autenticada GET
Devuelve el uso y los límites actuales de la cuota de la empresa — una entrada por ventana de cuota, como por minuto o por día. Todas las API keys de la empresa comparten esta cuota. Usa este endpoint para autolimitar tu ritmo antes de hacer solicitudes de analítica costosas. Notas: - Cuando una métrica no tiene tope, la respuesta devuelve `limit: null` y `remaining: null` para que no dividas por cero. - Cuando la empresa no tiene cuota, `quotas` es una lista vacía. - Una sola solicitud a la API puede contar como más de una consulta contra `max_queries_per_minute`, así que el contador `queries` puede subir más rápido que tu ritmo de solicitudes. La respuesta incluye `queries.note` para señalarlo cuando se aplica un límite estricto. `read_bytes` refleja los datos realmente escaneados y es la señal más fiable para dimensionar el uso. - Este endpoint cuenta en sí mismo como 1 consulta contra `max_queries_per_minute`.
Cómo funciona el merge-patch
La única regla detrás de cada actualización de vídeo: envía solo lo que quieres cambiar.