Saltar a contenido

Ejemplos de recopilación

Las ocho exportaciones del spec datahub alimentan un almacén de datos a partir de la explotación de un grupo. Esta página ofrece un ejemplo ejecutable para cada una, en el lenguaje seleccionado en la cabecera — actualmente Python.

Todos los ejemplos se autentican con una clave de API, transmitida en la cabecera Authorization. La página Autenticación describe cómo obtenerla. Leen sus entradas del entorno:

Variable Contenido
GROUP_ID El identificador del grupo que se va a exportar
PYSAE_API_KEY La clave de API con los permisos de exportación

Antes de empezar: las firmas son distintas

Las ocho exportaciones no se llaman de la misma manera. Conviven tres familias, y no existe ninguna llamada genérica que cubra las ocho.

Exportación Parámetros
trips date (obligatorio)
trip-km, passenger-counts start_date, end_date (obligatorios)
punctuality, trip-tracking start_date (obligatorio), end_date
drivers, vehicles, alerts ningún parámetro obligatorio

Escriba las fechas en el formato compacto AAAAMMDD — por ejemplo 20260131. Es el único formato que aceptan los cinco endpoints con fecha. punctuality y trip-tracking toleran también la forma AAAA-MM-DD, pero los otros tres la rechazan: atenerse al formato compacto evita tener que recordar cuáles.

La página Estadísticas y exportaciones de la guía detalla lo que devuelve cada una.

Expediciones realizadas

GET /api/v4/groups/{group_id}/export/trips abarca una jornada, designada por date. Para cubrir un periodo, encadene una llamada por día.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/trips",
    headers={"Authorization": f"Api-Key {api_key}"},
    params={"date": "20260131"},
    timeout=None,
)
response.raise_for_status()

with open("trips.csv", "wb") as file:
    file.write(response.content)

Kilómetros recorridos

GET /api/v4/groups/{group_id}/export/trip-km acota un periodo con start_date y end_date, ambos obligatorios.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/trip-km",
    headers={"Authorization": f"Api-Key {api_key}"},
    params={"start_date": "20260101", "end_date": "20260131"},
    timeout=None,
)
response.raise_for_status()

with open("trip-km.csv", "wb") as file:
    file.write(response.content)

Recuento de viajeros

GET /api/v4/groups/{group_id}/export/passenger-counts sigue la misma firma que los kilómetros.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/passenger-counts",
    headers={"Authorization": f"Api-Key {api_key}"},
    params={"start_date": "20260101", "end_date": "20260131"},
    timeout=None,
)
response.raise_for_status()

with open("passenger-counts.csv", "wb") as file:
    file.write(response.content)

Puntualidad

GET /api/v4/groups/{group_id}/export/punctuality solo requiere start_date. El endpoint acepta además filtros opcionales —event, stop_id, gtfs_id, driver_id, route_id— para restringir la exportación.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/punctuality",
    headers={"Authorization": f"Api-Key {api_key}"},
    params={"start_date": "20260101", "end_date": "20260131"},
    timeout=None,
)
response.raise_for_status()

with open("punctuality.csv", "wb") as file:
    file.write(response.content)

Seguimiento de expediciones

GET /api/v4/groups/{group_id}/export/trip-tracking requiere start_date y end_date.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/trip-tracking",
    headers={"Authorization": f"Api-Key {api_key}"},
    params={"start_date": "20260101", "end_date": "20260131"},
    timeout=None,
)
response.raise_for_status()

with open("trip-tracking.csv", "wb") as file:
    file.write(response.content)

Conductores

GET /api/v4/groups/{group_id}/export/drivers exporta el referencial de conductores, sin noción de periodo. El parámetro opcional archived permite incluir los conductores archivados, que no aparecen por defecto.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/drivers",
    headers={"Authorization": f"Api-Key {api_key}"},
    timeout=None,
)
response.raise_for_status()

with open("drivers.csv", "wb") as file:
    file.write(response.content)

Vehículos

GET /api/v4/groups/{group_id}/export/vehicles exporta la flota. El parámetro opcional statuses la restringe a los vehículos en un estado determinado.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/vehicles",
    headers={"Authorization": f"Api-Key {api_key}"},
    timeout=None,
)
response.raise_for_status()

with open("vehicles.csv", "wb") as file:
    file.write(response.content)

Alertas

GET /api/v4/groups/{group_id}/export/alerts exporta los mensajes de información a los viajeros del grupo. Sin parámetros.

import os

import httpx

group_id = os.environ["GROUP_ID"]
api_key = os.environ["PYSAE_API_KEY"]

response = httpx.get(
    f"https://api.pysae.com/api/v4/groups/{group_id}/export/alerts",
    headers={"Authorization": f"Api-Key {api_key}"},
    timeout=None,
)
response.raise_for_status()

with open("alerts.csv", "wb") as file:
    file.write(response.content)

En producción

  • Divida los periodos largos. Un tramo mensual se puede retomar tras un fallo; una exportación anual vuelve a empezar desde cero.
  • No fije un tiempo de espera corto. Las respuestas se transmiten de forma continua y una exportación amplia tarda en comenzar: un cliente que impone un plazo ajustado corta la conexión antes de la primera fila.
  • Repetir una exportación no tiene efectos secundarios. Estos endpoints son de solo lectura.
  • Compruebe el perímetro de la clave. Una clave restringida a determinados equipos exporta menos filas, sin que la respuesta lo indique.

Nota interna

Hay endpoints internos que sirven los mismos datos para los usos de back-office. No están destinados a las integraciones externas.