Ara est une application permettant de faire transiter les flux décrivant l’offre de transport en temps-réel sur un ou plusieurs réseaux.
Les entités auprès desquelles sont collectées les données temps réel ou vers lesquelles sont diffusées les données temps réel sont appelées des Partenaires d’Echange.
D'un point de vue fonctionnel, chaque Partenaire d'Échange nécessite une configuration personnalisée des connecteurs sur la plateforme Ara SaaS.
Référentiel
Le Client dispose d’un ou plusieurs Référentiels dont il est propriétaire.
Chaque Référentiel Ara permet de :
configurer les Partenaires d'Échange souhaités par le Client, et ainsi contrôler les flux d’information qui seront collectés et diffusés par Ara
réunir les données temps-réel (arrêts, lignes, courses) collectées auprès des différents Partenaires d'Échange
isoler les données des autres Référentiels
prédéfinir les informations (arrêts, lignes, courses) gérées par Ara quotidiennement
Chaque référentiel offre un ensemble d'informations :
Le nom du référentiel.
Le nom court du référentiel, nécessaire pour l'utilisation des différentes API d'Ara.
L'URL des API.
La description et l’utilisation des API (parmi d’autres) est disponible dans de nombreux langages via notre documentation Postman.
Partenaires d'échanges
Chaque Partenaire d'Échange regroupe :
Une sélection de connecteurs définissant les protocoles (SIRI, GTFS, SIRI Lite, etc) et les types d'échanges (abonnement, requête, etc) :
Un paramétrage spécifique de ces connecteurs tels que
Les URL distantes, les types d'identifiants,
Les token utilisés pour l'authentification des requêtes
L'état courant des échanges en cours, tels que les abonnements actifs, les derniers états transmis, les caches de données, etc
Le suivi des requêtes : le comptage et la limitation des requêtes associées à ce partenaire d'échange.
Le détail de ces paramètres est fourni ici : Liste des paramètres de partenaire d'Ara
Configuration d’un Partenaire d’Échange SIRI en collecte
La configuration d’un partenaire d’échange SIRI nécessite seulement quatre paramètres :
Les connecteurs auxquels souscrire pour le partenaire d’échange
L’URL publique du serveur d’échange SIRI du SAE pour transmettre les requêtes
L’identifiant utilisé par Ara dans ses requêtes de données transmises au serveur du SAE
L’identifiant utilisé par le serveur du SAE en tant que producteur de données dans les notifications transmises à Ara
Le pas-à-pas ci-dessous détaille les différentes étapes de configuration d’un partenaire d’échange.
Une fois connecté à votre interface Ara, accédez au menu de configuration d’un Partenaire d’Echange de votre Référentiel (menu à gauche)
En cliquant sur la section Partenaires d'échange, la liste des partenaires d’échange déjà configurés (si existant) apparaît dans la section centrale de l‘interface.
Cliquez sur le bouton “Ajouter un nouveau partenaire” dans le menu supérieur, à droite.
Une fois dans le menu de configuration d’un partenaire, renseignez les informations de paramétrage énumérées ci-dessous dans les champs prévus :
En plus du nom, votre Partenaire d’Echange comprend les paramètres suivants :
Il est complété par un identifiant, renseigné dans la section ‘local_credential’ qui autorise les requêtes SIRI transmises au serveur SIRI du SAE.
Le champ ‘remote_url’ désigne l’URL publique du service SIRI de votre SAE pour transmettre les requêtes à Ara.
Le champ ‘remote_credential’ est l’identifiant qui autorise la transmission des notifications du serveur SIRI du SAE à Ara.
Le champ ‘Connecteurs’ désigne l’ensemble des services auxquels vous souhaitez souscrire pour le partenaire d’échange. ll permet la sélection de plusieurs services en cochant ou décochant indépendamment chaque service dans le menu déroulant (icône ‘check’).
Une fois les champs renseignés, cliquez sur ‘Créer un Partenaire’ afin d’enregistrer votre sélection et de confirmer la création de votre partenaire d’échange.
Les informations liées à votre partenaire d’échange sont consultables dans la section Partenaires de votre espace de travail. Cliquez sur le nom du partenaire d’échange que vous venez de créer dans la liste.
Les détails de votre Partenaire d’Échange indiquent les paramètres renseignés lors de sa configuration dans la rubrique ‘Settings’ ainsi que la liste des services souscrits pour ce partenaire dans la rubrique ‘Connectors’.
Il est possible de modifier les paramètres de configuration du Partenaire d’Échange (ajouter un connecteur / service SIRI par exemple) en cliquant sur ‘Modifier ce Partenaire’ dans le menu supérieur, à droite.
Configuration d’un Partenaire d’Echange GTFS-RT en collecte
Statut
Dans l’interface principale pour chaque référentiel temps réel, vous pouvez visualiser l’ensemble des partenaires d’échange.
Parmi les informations affichées, l’interface indique le statut des partenaires d'échange, leurs noms, leurs noms courts et les informations de configuration des partenaires d’échange (types de service souscrits et paramètres de configuration).
L’information de statut du partenaire d’échange consiste en 3 états distincts :
Disponible
Indisponible
Inconnu
L’état est modifié uniquement si le partenaire d’échange utilise une requête CheckStatus ou une sonde Scops.
.png?version=1&modificationDate=1663923605337&cacheVersion=1&api=v2)
L’état Disponible indique que le partenaire d’échange a répondu positivement à la vérification d’activité qui lui a été envoyée par Ara. En conséquence, il est en état de fonctionnement et prêt à répondre à toute requête.
L’état Indisponible indique que le partenaire d’échange n’a pas répondu favorablement à la vérification d’activité qui lui a été envoyé par Ara. Ara est donc en mesure de communiquer avec ce partenaire d’échange, mais celui-ci n’est pas disponible ou n’est pas en état de fonctionnement. Cette indisponibilité du partenaire d'échange peut être le signe de problèmes dans le fonctionnement ou le paramétrage du côté du partenaire d’échange.
.png?version=1&modificationDate=1663923605343&cacheVersion=1&api=v2)
L’état Inconnu indique soit qu’Ara est incapable de procéder à la vérification d’activité du partenaire d’échange (problème de réseau, etc.), soit encore que les services souscrit ne permettent pas la mise à jour du statut (il s’agit alors d’une situation normale).
Ce statut indique s’il est en état de fonctionnement ou non, mais ne signale pas si des données sont échangées ou non entre Ara SaaS et le partenaire d’échange.