Saltar a contenido

Sincronizaciones GTFS externas

Una red cuyo GTFS se produce en otro lugar — un agregador regional, un software de planificación — no tiene que importarlo a mano. Una sincronización externa recupera cada día el archivo desde una URL y, si ha cambiado desde el día anterior, lo importa y lo publica.

Una sincronización, un archivo, una hora

Una sincronización contiene la URL del archivo y la hora a la que recuperarlo. Cada sincronización tiene su propia ejecución diaria: dos redes sincronizadas no se procesan necesariamente a la misma hora. Elija una hora posterior a aquella en la que la fuente genera su archivo, para no recuperar el del día anterior.

Endpoint Función
GET /api/v4/groups/<group_id>/gtfs/external-synchronizations Lista las sincronizaciones del grupo y el resultado de su última ejecución
POST /api/v4/groups/<group_id>/gtfs/external-synchronizations Crea una sincronización
PATCH /api/v4/groups/<group_id>/gtfs/external-synchronizations/<synchronization_id> Cambia su URL, su hora o su zona horaria, o la suspende

Estas rutas requieren el rol admin en el grupo.

Los ajustes

  • url: la URL HTTP(S) del archivo. Su host debe resolverse únicamente a direcciones públicas: una dirección local, privada o interna se rechaza con 422 GTFS_EXTERNAL_SYNCHRONIZATION_URL_REJECTED.
  • time: la hora local de recuperación, en formato "HH:MM", 00:00 por defecto. Una hora con desfase (01:00+01:00) se rechaza: es la zona horaria la que sigue el cambio de hora.
  • timezone: la zona horaria IANA de esa hora ("Europe/Paris"). Sin ella, se usa la zona horaria del grupo, la del GTFS publicado: la sincronización la sigue cuando una publicación la cambia. Volver a ponerla en null restablece la zona horaria del grupo.
  • enabled: false suspende la sincronización sin eliminarla.

El resultado de la última ejecución

Cada sincronización conserva, en solo lectura, lo que dio su última ejecución:

  • last_status: imported (un nuevo archivo importado y publicado), unchanged (el mismo archivo que la última vez, no se importa nada) o failed;
  • last_error: el motivo de un fallo, vacío tras un éxito;
  • last_checksum y last_gtfs_id: la huella MD5 del último archivo publicado y el GTFS que creó;
  • last_attempt_at: la fecha de esa ejecución.

Un archivo inaccesible se reintenta varias veces antes de declararse en fallo. Un archivo importado cuya publicación falla no se considera publicado: la noche siguiente lo vuelve a importar.

El informe de ejecución

El flow de Prefect Synchronize external transit files ejecuta una sincronización por run, planificado por la API a la hora de la sincronización, y comunica su resultado mediante una ruta interna reservada al superadministrador.

Endpoint Función
POST /api/v4/groups/<group_id>/gtfs/external-synchronizations/<synchronization_id>/results Registra el resultado de una ejecución

Los subcomandos pysae_admin import-gtfs-external-synchronizations y pysae_admin reconcile-gtfs-external-synchronization-schedules retoman las sincronizaciones del antiguo bloque de Prefect y realinean las planificaciones del despliegue con las sincronizaciones. Mientras no se haya hecho la migración, el antiguo run diario, lanzado sin parámetros, sigue procesando el antiguo bloque; la reconciliación elimina su schedule. Ambos subcomandos se lanzan en la misma sesión, para que ninguna red se procese dos veces la misma noche.