API HTTP
Alta tiene una API HTTP con solicitudes y respuestas en JSON. Úsela para crear canales, conectar transmisiones de entrada, gestionar los almacenamientos del archivo y el control de acceso, y leer el estado del servicio desde su sistema de facturación, su middleware o sus scripts.
La interfaz web de Alta usa la misma API, de modo que todo lo que puede hacer en la interfaz se puede automatizar.
URL base
Sección titulada «URL base»Todas las solicitudes van al API Server, no al OTT Server que atiende a los espectadores. El puerto predeterminado es 8100. Más información en Servidor HTTP.
http://alta.example.com:8100/api/...Autenticación
Sección titulada «Autenticación»Todas las solicitudes, excepto /api/login, necesitan las credenciales de un usuario de Alta. Hay dos formas:
- Token Bearer: obtenga un token con
POST /api/loginy envíelo en el encabezadoAuthorization: Bearer <token>. - HTTP Basic: envíe el inicio de sesión y la contraseña del usuario en cada solicitud.
Más información en Inicio rápido.
El rol del usuario determina lo que permite la API. Los roles se establecen en Usuarios.
| Rol | Acceso |
|---|---|
admin | Todas las solicitudes de esta sección |
observer | Solo lectura: Estado, receptores (GET, estado), almacenamiento de canales, vistas previas y exportación M3U |
anonymous | Sin acceso. Todas las solicitudes devuelven 401 |
Cualquier usuario autenticado puede leer sus propias opciones y cambiar su propia contraseña. Consulte Usuarios.
Solicitudes y respuestas
Sección titulada «Solicitudes y respuestas»- Envíe los cuerpos JSON con el encabezado
Content-Type: application/json. - Una solicitud de un solo elemento usa el parámetro de consulta
id, por ejemplo/api/ott/receiver?id=news-hd. - Los ID de canales y variantes contienen una barra, por ejemplo
discovery/hd. Envíe la barra tal cual o codificada en URL como%2F. POSTcrea un elemento,PUTlo reemplaza yDELETElo elimina. Una solicitudPUTreemplaza todos los campos del elemento. Envíe el objeto completo, no solo los campos modificados.- Una solicitud correcta que modifica datos devuelve
204 No Contentcon el cuerpo vacío. Alta guarda la configuración antes de responder. - Alta no tiene solicitudes que devuelvan listas de canales, receptores o almacenamientos. Para obtener los ID de los elementos, use las solicitudes de estado, por ejemplo estado del receptor, estado del almacenamiento y estado de las sesiones.
Códigos de respuesta
Sección titulada «Códigos de respuesta»| Código | Descripción |
|---|---|
200 | Correcto, con cuerpo |
204 | Correcto, o el elemento no tiene nada que devolver, por ejemplo un canal sin almacenamiento |
400 | Falta el parámetro id o la solicitud no es válida. El cuerpo puede contener el motivo como texto sin formato |
401 | Sin credenciales, o las credenciales son incorrectas |
403 | El rol del usuario no permite la solicitud. Inicio de sesión o contraseña incorrectos en /api/login |
404 | El elemento no existe |
409 | El elemento ya existe, o un receptor ya lo usa otro canal |
422 | El valor de un campo no es válido |
500 | Alta no pudo guardar la configuración |
Recursos
Sección titulada «Recursos»| Sección | Qué puede hacer |
|---|---|
| Inicio rápido | Iniciar sesión y publicar el primer canal |
| Estado | Leer la versión, el tiempo de actividad, la CPU, la memoria y el espacio en disco |
| Canales | Crear, modificar, iniciar, detener y eliminar canales, y exportar listas M3U |
| Receptores | Gestionar las transmisiones de entrada e importar canales desde una lista M3U |
| Almacenamientos | Gestionar los almacenamientos del archivo y leer su tamaño |
| API de vista previa | Descargar clips de vista previa MP4 del archivo |
| Autorizadores | Gestionar las reglas de acceso y generar valores de Securetoken |
| Sesiones | Ver quién está viendo ahora |
| Acceso HLS | Cambiar la duración de los segmentos y el tamaño de la lista |
| Usuarios | Gestionar usuarios y contraseñas |