Open data du réseau Ginko

Ce site s'adresse à des développeurs en informatique

Une clé d'API est maintenant nécessaire

Une clé d'API est maintenant obligatoire pour chaque requête effectuée sur l'API. L'utilisation de l'API demeure gratuite. La clé nous permet d'obtenir des statistiques d'utilisation et de mettre en place une gestion de droits pour accéder à des informations complémentaires comme l'affluence.

Demandez dès maintenant votre clé en nous contactant à l'adresse ginko.support-ssi@keolis.com

Informations proposées en Open Data

Certaines informations sont disponibles via une API, d'autres sont proposées sous forme d'un jeu de fichiers au format GTFS. Lisez attentivement les informations ci-dessous pour connaître les différences entre ces deux sources de données.

API Temps Réel

Structure des lignes, recherche d'arrêts, horaires de passage en temps réel...

API REST API Javascript

GTFS lignes urbaines et périurbaines

Données théoriques des lignes urbaines et périurbaines Ginko (horaires, itinéraires). Fichier mis à jour à chaque changement d'offre, y compris lors des évolutions de l'offre pendant la crise sanitaire. Les données actuelles sont valables jusqu'au inclus.

Télécharger

L'API permet d'effectuer des requêtes précises pour rechercher des informations à la demande; elle donne également accès aux données temps réel du réseau Ginko (temps d'attente et infos-trafic). Nous vous conseillons de l'utiliser si votre application dispose d'un accès internet permanent lors de son utilisation. Le format GTFS donne accès à toutes les informations statiques du réseau (structure des lignes, horaires théoriques), il peut donc être chargé au démarrage de l'application afin que celle-ci ne soit plus dépendante de la connexion réseau par la suite. Une utilisation conjointe du fichier GTFS et de l'API peut être pertinente si vous développez une application de navigation.

Informations disponibles Lignes urbaines Lignes périurbaine
API GTFS API GTFS
Nom et position GPS des arrêts Oui Oui Oui Oui
Structure des lignes Oui Oui Oui Oui
Horaires théoriques Non Oui Non Oui
Tracé GPS des lignes (en suivant les routes) Non Oui Non Oui
Informations d'accessibilité des arrêts Oui Oui Oui Oui
Informations d'accessibilité des véhicules Oui Non Oui Non
Tarifs des titres de transport et abonnements Oui Non Oui Non
Temps d'attente en temps réel Oui Non Oui Non
Infos-trafic (perturbations anticipées ou non) Oui Non Oui Non
Informations temps réel sur les véhicules Oui Non Non Non
Prévision d'Affluence de la journée Oui Non Non Non
Affluence temps réel par véhicule Oui Non Non Non
Prévision d'affluence temps réel par station Oui Non Non Non

En raison de la complexité inhérente aux particularités de ces services, l'ouverture des données des services spéciaux, scolaires, et services à la demande n'est pas planifiée pour le moment.

Licence d'utilisation

Les données ouvertes du réseau Ginko sont mises à disposition gratuitement.

Les données sont mises à disposition sous Licence ODbL (Open Database Licence). L'utilisation de l'API et/ou le téléchargement du jeu de données GTFS vaut acceptation de la licence. Cette licence vous impose notamment de mentionner la provenance des informations utilisées par vos développements, ce qui peut se faire par exemple par un lien vers ce site.

Cette licence implique que vous êtes libres de :

à partir de notre base de données ...

Du moment que vous :

Continuité de service

Toute modification apportée dans la diffusion des données fera l’objet d’une information sur ce site décrivant les nouvelles modalités dans un délai d’un mois au moins avant application de la modification. Pour être notifié par email de ces modifications, faites-en la demande à l'adresse ginko.support-ssi@keolis.com.

Disclaimer

Malgré tout le soin que nous y avons accordé, la documentation peut contenir des inexactitudes. Les informations proposées ne font l'objet d'aucune garantie. La responsabilité de Keolis Besançon Mobilités, exploitant du réseau urbain Ginko, ni celle de Grand Besançon Métropole, Autorité Organisatrice des Mobilités, ne sauraient être engagées en cas de dysfonctionnement temporaire de cette plateforme ou d'inexactitude dans les informations qu'elle fournit.

N'hésitez pas à nous remonter les éventuels bugs et erreurs dans la documentation à l'adresse ginko.support-ssi@keolis.com.

L'API Javascript est un outil facultatif destiné à accélérer le développement de votre application web. Elle fournit un moyen simple et rapide d'interroger l'API bas niveau, de récupérer les résultats et de traiter les erreurs. (Testé avec la dernière version d'Internet Explorer, Firefox et Chrome, mais fonctionne sûrement avec les versions plus anciennes et d'autres navigateurs.)

Mise en oeuvre

Il suffit d'inclure le script https://api.ginko.voyage/api.js dans la balise HEAD de votre page, en fournissant votre clé API si vous en avez une, comme ceci:

<script type="text/javascript" src="https://api.ginko.voyage/api.js?apiKey=XXX"></script>

Utilisez ensuite la méthode: ginkoAPI(methodPath, args, success [, error] [, timeout]) pour interroger l'API:

Paramètre Type Description
methodPath* Chaine Chemin de la méthode de l'API à invoquer. Il est indiqué dans la documentation de chaque méthode (parcourez les onglets à gauche pour découvrir les méthodes disponibles).

Exemple:
DR/getDetailsVariante
args* Objet Objet contenant les paramètres demandés par la méthode de l'API. Si vous n'avez pas de paramètre à transmettre, spécifiez un objet vide { }. Il n'est pas nécessaire de fournir votre clé d'API à chaque requête (celle-ci étant fournie lors du chargement de l'API).

Exemple:
{ idLigne: "3", idVariante: "34-0" }
success* Méthode Méthode callback invoquée en cas de succès de la requête. Reçoit un seul paramètre, qui est le résultat décapsulé de la méthode de l'API (décrit dans la documentation de la méthode).

Exemple:
function(listeArrets){ ... }
error Méthode Méthode callback invoquée en cas d'échec de la requête. Reçoit un message d'erreur en paramètre. Il n'est pas obligatoire de fournir un callback d'erreur, toutefois, si vous ne le faites pas, votre application risque de planter discrètement sans que l'utilisateur en soit informé.

Si vous ne souhaitez pas fournir ce paramètre, spécifiez null pour pouvoir indiquer le paramètre suivant.

Exemple:
function(msg){
    alert(msg); 
}
timeout Entier Délai maximal d'éxécution de la requête, en secondes. Ce paramètre est optionnel (10 secondes par défaut).

Exemple simple

Visitez cette page et consultez sa source.

Contact

Pour toute question ou problème lié à l'utilisation des données ouvertes Ginko, vous pouvez nous contacter à l'adresse ginko.support-ssi@keolis.com.

Clé Temporaire

Pour pouvoir utiliser l'API de manière temporaire, vous pouvez utiliser une clé temporaire générée tous les jours. Cette clé est valable uniquement 24h, et il sera nécessaire de récupérer la nouvelle clé le lendemain. Pour obtenir une clé permanente, rendez-vous dans la section "Contact" afin d'effectuer votre demande.

Veuillez saisir les chiffres visibles à l'écran