Saltearse al contenido
Productos

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.

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/...

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/login y envíelo en el encabezado Authorization: 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.

RolAcceso
adminTodas las solicitudes de esta sección
observerSolo lectura: Estado, receptores (GET, estado), almacenamiento de canales, vistas previas y exportación M3U
anonymousSin acceso. Todas las solicitudes devuelven 401

Cualquier usuario autenticado puede leer sus propias opciones y cambiar su propia contraseña. Consulte Usuarios.

  • 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.
  • POST crea un elemento, PUT lo reemplaza y DELETE lo elimina. Una solicitud PUT reemplaza todos los campos del elemento. Envíe el objeto completo, no solo los campos modificados.
  • Una solicitud correcta que modifica datos devuelve 204 No Content con 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ódigoDescripción
200Correcto, con cuerpo
204Correcto, o el elemento no tiene nada que devolver, por ejemplo un canal sin almacenamiento
400Falta el parámetro id o la solicitud no es válida. El cuerpo puede contener el motivo como texto sin formato
401Sin credenciales, o las credenciales son incorrectas
403El rol del usuario no permite la solicitud. Inicio de sesión o contraseña incorrectos en /api/login
404El elemento no existe
409El elemento ya existe, o un receptor ya lo usa otro canal
422El valor de un campo no es válido
500Alta no pudo guardar la configuración
SecciónQué puede hacer
Inicio rápidoIniciar sesión y publicar el primer canal
EstadoLeer la versión, el tiempo de actividad, la CPU, la memoria y el espacio en disco
CanalesCrear, modificar, iniciar, detener y eliminar canales, y exportar listas M3U
ReceptoresGestionar las transmisiones de entrada e importar canales desde una lista M3U
AlmacenamientosGestionar los almacenamientos del archivo y leer su tamaño
API de vista previaDescargar clips de vista previa MP4 del archivo
AutorizadoresGestionar las reglas de acceso y generar valores de Securetoken
SesionesVer quién está viendo ahora
Acceso HLSCambiar la duración de los segmentos y el tamaño de la lista
UsuariosGestionar usuarios y contraseñas