Pysae API documentation¶

The Pysae API exposes the operational data of a transit network: GTFS schedule reference, planned and actual trips, real-time vehicle positions, driver duties, and statistical exports.

This written documentation complements the technical reference, which remains the OpenAPI spec.

The site header offers three selectors: the documentation language (French or English), the code language of the examples (cURL, Python or Node.js) and the endpoint category (public, internal, datahub). Each change applies to the current page without leaving it, and the chosen language and code language are remembered between visits.

Technical reference¶

Versioning and categories¶

The API is versioned from v2 to v5. Version v4 is the default, v3 is deprecated. Each version is published in three categories:

• public — endpoints intended for integrators (the subject of this documentation);
• internal — internal endpoints, not intended for integrators;
• datahub — bulk data feeds.

The version prefix and the category are part of the path, for example /api/v4/... for the default public category.

Where to start¶

• System guide — how the API's objects fit together, from the reference to the exports.
• Entity glossary — the business objects the API handles, their role and their relations.
• Authentication — accepted mechanisms, obtaining a session and API keys.
• Collection examples — authentication and data export, in your language.