Documentation de l'API Pysae¶
L'API Pysae expose les données d'exploitation d'un réseau de transport : référentiel théorique GTFS, courses planifiées et réalisées, positions temps réel des véhicules, services de conduite, et exports statistiques.
Cette documentation rédigée accompagne la référence technique, qui reste le spec OpenAPI.
L'en-tête du site propose trois sélecteurs : la langue de la documentation (français ou anglais), le langage des exemples de code (cURL, Python ou Node.js) et la catégorie d'endpoints (public, internal, datahub). Chaque changement s'applique à la page courante sans la quitter ; la langue et le langage choisis sont retenus d'une visite à l'autre.
Référence technique¶
| Ressource | Lien |
|---|---|
| Swagger UI | /api/docs/v4/internal/swagger-ui |
| ReDoc | /api/docs/v4/internal/redoc |
| Spec OpenAPI (JSON) | /api/docs/v4/internal/openapi.json |
Versionnement et catégories¶
L'API est versionnée de v2 à v5. La version v4 est celle par défaut, v3 est dépréciée. Chaque version est publiée en trois catégories :
public— endpoints destinés aux intégrateurs (l'objet de cette documentation) ;internal— endpoints internes, non destinés aux intégrateurs ;datahub— flux de données en masse.
Le préfixe de version et la catégorie font partie du chemin, par exemple /api/v4/... pour la catégorie publique par défaut.
Catégorie interne
Cette variante du site documente également les endpoints internes, qui ne sont pas destinés aux intégrateurs.
Par où commencer¶
- Guide du système — comment les objets de l'API s'articulent, du référentiel aux exports.
- Glossaire des entités — les objets métier manipulés par l'API, leur rôle et leurs relations.
- Authentification — mécanismes acceptés, obtention d'une session et clés d'API.
- Exemples de collecte — authentification et export de données, dans votre langage.