Saltearse al contenido
Productos

Inicio rápido de la API HTTP

Este artículo muestra cómo iniciar sesión en la API HTTP de Alta y publicar un canal con curl. Para una descripción general de los roles, los códigos de respuesta y las convenciones, lea API HTTP.

  • Las solicitudes se envían al API Server (puerto predeterminado 8100), no al OTT Server. Más información en Servidor HTTP.
  • Necesita un usuario de la interfaz web de Alta con el rol admin. Más información en Usuarios.

La API admite dos métodos:

  • Token Bearer: obtenga un token con /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.

Inicie sesión:

Ventana de terminal
curl -sS -X POST 'http://alta.example.com:8100/api/login' \
-H 'Content-Type: application/json' \
-d '{"id": "admin", "password": "PASSWORD"}'

La respuesta es el token como texto sin formato. Guárdelo en una variable:

Ventana de terminal
TOKEN=$(curl -sS -X POST 'http://alta.example.com:8100/api/login' \
-H 'Content-Type: application/json' \
-d '{"id": "admin", "password": "PASSWORD"}')

Compruebe el token con la solicitud de información de la aplicación:

Ventana de terminal
curl -sS -H "Authorization: Bearer $TOKEN" 'http://alta.example.com:8100/api/about'

Con HTTP Basic, use la opción -u de curl en lugar del token:

Ventana de terminal
curl -sS -u 'admin:PASSWORD' 'http://alta.example.com:8100/api/about'

Un canal necesita un receptor con la transmisión de entrada. Cree primero el receptor y después el canal que lo usa.

1. Cree un receptor:

Ventana de terminal
curl -sS -X POST 'http://alta.example.com:8100/api/ott/receiver' \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"id": "news-source",
"name": "News source",
"source": "udp://239.1.1.1:1234",
"enable": true
}'

2. Cree un canal con una variante:

Ventana de terminal
curl -sS -X POST 'http://alta.example.com:8100/api/ott/channel' \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"id": "news",
"name": "News",
"enable": true,
"variants": {
"main": { "enable": true, "receiver": "news-source" }
}
}'

Ambas solicitudes devuelven 204 con el cuerpo vacío.

3. Abra la lista de reproducción en un reproductor. La lista la sirve el OTT Server, no el API Server:

http://alta.example.com:<ott-port>/news/index.m3u8

El puerto OTT se define en Settings → HTTP Servers. Más información sobre las direcciones de las listas de reproducción en Formato de URL para acceso HLS.

4. Compruebe los espectadores:

Ventana de terminal
curl -sS -H "Authorization: Bearer $TOKEN" 'http://alta.example.com:8100/api/ott/sessions/status'

Para eliminar el ejemplo, elimine primero el canal y después el receptor:

Ventana de terminal
curl -sS -X DELETE -H "Authorization: Bearer $TOKEN" 'http://alta.example.com:8100/api/ott/channel?id=news'
curl -sS -X DELETE -H "Authorization: Bearer $TOKEN" 'http://alta.example.com:8100/api/ott/receiver?id=news-source'
  • Canales: variantes, almacenamiento del archivo, control de acceso, inicio y detención.
  • Receptores: orígenes e importación desde una lista M3U.
  • Autorizadores: proteja los canales con reglas de IP o Securetoken.