Autenticación
Obtener una Clave API
Puedes crear una Clave API en la página Integraciones API de la interfaz de administración de Ignite. Necesitas un rol admin para acceder a esta página.
Al crear una clave, elige sus permisos y un alcance opcional de categorías.
Permisos
Los permisos de la Clave API se conceden por recurso. Activa solo las acciones que tu integración necesita.
| Recurso | Acciones disponibles |
|---|---|
| Vídeos | read, create, update, delete, publish |
| Eventos en vivo | read, create, update, delete, publish |
| Tags | create, update, delete |
| Categorías | create, update, delete |
| Analytics | read |
El acceso de lectura a categorías, tags y presets del reproductor siempre está concedido. No necesitas activarlo. Las claves API no pueden crear, actualizar ni eliminar presets del reproductor.
publish es independiente de create y update. visibility: public solo se guarda cuando la clave tiene videos.publish. Sin ese permiso, crear guarda private. Un PATCH que establece visibility se acepta, el campo permanece sin cambios y la respuesta sigue siendo 200. Ninguno de los dos casos devuelve 403.
Los endpoints de Analytics requieren analytics.read. Solo read de vídeos no es suficiente. Consulta Analytics.
Las Claves API no pueden gestionar miembros, webhooks, otras integraciones API ni la configuración de la cuenta.
Alcance de categorías
Puedes limitar una Clave API a una o más categorías. El alcance incluye esas categorías y sus subcategorías. Filtra las lecturas y escrituras de vídeos, y las lecturas, actualizaciones y eliminaciones de categorías. Una clave con alcance no puede eliminar una categoría que sea uno de sus anclajes de alcance. Si creas un vídeo y no envías categorías, se asignan las categorías del alcance, hasta 10. Si dejas el campo vacío, la clave puede acceder a todas las categorías del espacio de trabajo.
El alcance de categorías no limita los tags ni los eventos en vivo. Se aplica a las llamadas de Analytics por vídeo.
Usar una Clave API
Pasa tu Clave API como Token Bearer en el encabezado Authorization de tu solicitud.
CURL
curl -X GET https://app.ignitevideo.cloud/api/videos \
-H "Authorization: Bearer YOUR_API_KEY"Clave API ausente o no válida
Una Clave API ausente o no válida devuelve 403:
{
"errors": [
{
"message": "You are not allowed to perform this action"
}
]
}Formas de respuesta de error
Los endpoints de colección (vídeos, categorías, tags y presets del reproductor) devuelven errores de Payload como { errors: [{ message }] }.
Los endpoints personalizados (subida, reemplazo, miniaturas, text tracks, subida multiparte y rutas de IA) devuelven { error, message? }. message se omite en algunos errores. Un fallo de permiso en esas rutas devuelve 403.
{
"error": "not_found"
}{
"error": "invalid_video_id"
}Un campo que no supera la validación en un endpoint de colección devuelve 400 con la forma de error de Payload.
Un GET de un vídeo, una categoría o un tag inexistente devuelve 404 { errors: [{ message: "Not Found" }] }. Un PATCH o DELETE de un id inexistente devuelve 403 con el error de Payload anterior. La respuesta es la misma cuando el documento no existe y cuando la clave no tiene permiso para verlo.