Saltar a contenido

Documentación de la API de Pysae

La API de Pysae expone los datos de explotación de una red de transporte: referencial teórico GTFS, expediciones planificadas y realizadas, posiciones en tiempo real de los vehículos, servicios de conducción y exportaciones estadísticas.

Esta documentación redactada acompaña a la referencia técnica, que sigue siendo la especificación OpenAPI.

La cabecera del sitio ofrece tres selectores: el idioma de la documentación (francés, inglés o español), el lenguaje de los ejemplos de código (cURL, Python o Node.js) y la categoría de endpoints (public, internal, datahub). Cada cambio se aplica a la página actual sin salir de ella; el idioma y el lenguaje elegidos se conservan de una visita a otra.

Referencia técnica

Recurso Enlace
Swagger UI /api/docs/v4/public/swagger-ui
ReDoc /api/docs/v4/public/redoc
Especificación OpenAPI (JSON) /api/docs/v4/public/openapi.json

Versionado y categorías

La API está versionada de v2 a v5. La versión v4 es la predeterminada y v3 está obsoleta. Cada versión se publica en tres categorías:

  • public — endpoints destinados a los integradores (el objeto de esta documentación);
  • internal — endpoints internos, no destinados a los integradores;
  • datahub — flujos de datos masivos.

El prefijo de versión y la categoría forman parte de la ruta, por ejemplo /api/v4/... para la categoría pública predeterminada.

Por dónde empezar