Inicio rápido de la API HTTP

Alta ofrece una API HTTP con solicitudes y respuestas JSON. La interfaz web usa la misma API. Este artículo muestra cómo iniciar sesión y leer el estado de la aplicación y del host.

Requisitos

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. Más información en Usuarios.

Autenticación

La API admite dos métodos:

Bearer token: Obtenga un token con /api/login y envíelo en el encabezado Authorization: Bearer <token>.
HTTP Basic: Envíe el nombre de usuario y la contraseña en cada solicitud.

Iniciar sesión:

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.

Use el token en las siguientes solicitudes:

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

Información de la aplicación

GET /api/about

Respuesta:

{
    "service_name": "alta",
    "version": {
        "version": "261020",
        "commit": "349de372",
        "build": 1638139770
    },
    "runtime": {
        "instance_id": "8b1f6c3e-6a52-4c0e-9d1a-5f2f2a0c9e11",
        "uptime": 86400
    }
}

service_name: Nombre del servicio.
version: Versión, commit y compilación de Alta.
runtime.instance_id: Identificador único de la instancia de Alta.
runtime.uptime: Tiempo de actividad de la aplicación en segundos.

Estado del host y del almacenamiento

GET /api/status

Respuesta:

{
    "host": {
        "cpu": { "usage_percent": 12.5, "load_avg": [0.4, 0.5, 0.6], "cores": 8 },
        "mem": { "total_bytes": 16777216000, "used_bytes": 4294967296, "available_bytes": 12482248704 }
    },
    "storages": [
        {
            "name": "archive",
            "path": "/var/lib/alta/archive",
            "total_bytes": 1000000000000,
            "used_bytes": 250000000000,
            "free_bytes": 750000000000
        }
    ]
}

host.cpu: Uso de CPU en porcentaje, carga promedio de 1, 5 y 15 minutos, y número de núcleos.
host.mem: Memoria total, usada y disponible en bytes.
storages: Nombre, ruta y espacio total, usado y libre en bytes de cada Almacenamiento.

Errores y parámetros

401 Unauthorized: No hay token, o el token no es válido o ha caducado.
403 Forbidden: El rol del usuario no permite la solicitud.
Las solicitudes de un único elemento, como un canal o un receptor, usan el parámetro de consulta id. Por ejemplo, /api/ott/channel/storage/preview?id=discovery/hd. Consulte un ejemplo completo en API de vista previa.