Referencia de la API HTTP
La API de OmniRoam sirve archivos TAP, archivos RAP, vistas CDR, totales, control de exportación y métricas. Esta guía enumera los puntos finales.
Tabla de Contenidos
Acceso
La API de OmniRoam escucha en el puerto 4000. La API sirve HTTP simple, sin TLS. Todos los puntos finales están bajo la ruta /api. La API devuelve JSON sin un sobre.
| Recurso | Ruta |
|---|
| Interfaz de usuario de Swagger | GET /api/docs |
| Esquema OpenAPI | GET /api/schema |
Archivos TAP
| Método y ruta | Propósito | Parámetros |
|---|
GET /api/tap_files_in | Listar los archivos TAP entrantes. | tadig (opcional) |
GET /api/tap_files_in/:filename | Devolver un archivo TAP entrante como JSON. | tadig, page, per_page |
GET /api/tap_files_out | Listar los archivos TAP salientes. | tadig (opcional) |
GET /api/tap_files_out/:filename | Devolver un archivo TAP saliente como JSON. | tadig, page, per_page |
La respuesta del archivo contiene el encabezado y una página de eventos de llamada. El valor de page comienza en 1. El valor de per_page tiene un valor predeterminado de 100 y un máximo de 2000. La respuesta devuelve 404 cuando el archivo no se encuentra.
Validación TAP
| Método y ruta | Propósito | Parámetros |
|---|
GET /api/tap_validate_in/:filename | Validar un archivo TAP entrante. | tadig (opcional) |
GET /api/tap_validate_out/:filename | Validar un archivo TAP saliente. | tadig (opcional) |
La respuesta informa si el archivo es válido, el conteo de hallazgos por severidad y la lista de hallazgos. Ver Validación TAP.
Archivos RAP
| Método y ruta | Propósito | Parámetros o cuerpo |
|---|
GET /api/rap_files | Listar los archivos RAP. | tadig (opcional) |
GET /api/rap_files/:filename | Devolver un archivo RAP como JSON enriquecido. | tadig (opcional) |
POST /api/rap_files/send_alert | Enviar una alerta por correo electrónico para un archivo RAP. | Cuerpo: filename (requerido), tadig |
Ver Procesamiento RAP.
Vistas CDR
| Método y ruta | Propósito | Parámetros |
|---|
GET /api/part_cdrs/:page | Listar las claves CDR parciales en vuelo desde Redis. | Ruta: page (entero) |
GET /api/cdrs_from_csv | Listar los archivos CDR en bruto, o descargar uno. | filename, raw_cdr_view_max_age |
GET /api/config_yaml | Devolver config.yaml. La API elimina el token de InfluxDB. | Ninguno |
GET /api/config | Devolver la sección config y los contadores. | Ninguno |
Carga CDR
| Método y ruta | Propósito | Cuerpo |
|---|
POST /api/ui_upload | Cargar un archivo CDR CSV en el directorio de OmniCore. | Multipart file. El nombre debe ser un nombre de archivo simple que termine en .csv — sin separadores de ruta. Devuelve 400 (rechazado), 409 (ya en uso), 413 (demasiado grande). |
La respuesta devuelve 200 en caso de éxito, 409 para un archivo duplicado y 500 para un archivo inválido. Ver Procesamiento CDR.
Totales y Monitoreo
| Método y ruta | Propósito | Parámetros |
|---|
GET /api/monitoring | Devolver totales de monitoreo, o descargar un archivo coincidente. | filename (opcional) |
GET /api/totals_monthly | Listar los socios con totales mensuales. | Ninguno |
GET /api/totals_monthly/:tadig | Devolver los totales mensuales para un TADIG. | year, month |
GET /api/totals_daily | Devolver los totales diarios a través de todos los TADIGs. | Ninguno |
GET /api/totals_daily/:tadig | Devolver los totales diarios para un TADIG. | Ninguno |
Exportación TAP
| Método y ruta | Propósito | Cuerpo |
|---|
POST /api/tap_export | Colocar en cola una exportación para un socio. | partner (requerido), records_per_file, max_files |
GET /api/tap_export | Listar los trabajos de exportación. | Ninguno |
GET /api/tap_export/:job_id | Devolver un trabajo de exportación. | Ninguno |
GET /api/export_schedule | Devolver el estado del programador y el estado de la cola. | Ninguno |
POST /api/export_schedule | Colocar en cola una exportación para cada socio ahora. | Ninguno |
Los puntos finales de exportación devuelven 202 cuando OmniRoam coloca el trabajo en cola. La cola de trabajos ejecuta una exportación a la vez. Ver la Guía de Operaciones.
Métricas
| Método y ruta | Propósito |
|---|
GET /api/metrics | Devolver las métricas de Prometheus. |
La respuesta es una exposición de texto de Prometheus. Un scrape lee un snapshot en caché. Ver la Referencia de Métricas.