Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Adapps lango switcher macro
Table of Contents

Description métier

La fonction «Publication» sert à partager en public l’ensemble de vos données en format GTFS ou NeTEx avec vos partenaires.

L’utilisateur autorisé et membre de l’organisation propriétaire du Groupe de Travail peut gérer les publications de données qui sont réalisées automatiquement.

...

Gestion des publications

Plusieurs Publications peuvent être définies au sein du Groupe de Travail. Chacune définissant un export et les destinations à donner aux informations exportées.

...

  • le nom (pour mieux identifier son rôle)

  • l’activation ou la désactivation

  • l’activation ou la désactivation de la Publication Quotidiennement

  • les paramètres de l’export

  • les destinations

Les paramètres de l’export

Plusieurs types d’export sont proposés par Chouette.

L’export GTFS :

Lors de l’export, un zip est créé contenant les fichiers .txt suivants :

...

  • Les arrêts référents. Vous pouvez indiquer que vous préférez ou non l’utilisation des arrêts référents pour votre export. Avec cette option, l’export GTFS utilisera les arrêts Référents (s'il y en a) au lieu des arrêts particuliers.

  • Les transporteurs référents. Vous pouvez indiquer que vous préférez ou non l’utilisation des transporteurs référents pour votre export. Avec cette option, l’export GTFS utilisera les transporteurs Référents (s'il y en a) au lieu des transporteurs particuliers.

  • Les lignes référentes.

  • Ignorer les arrêts parents. Les arrêts vont être exportés sans leurs parents.

  • La prise en compte des Zones de Lieux avec une Zone d’Embarquement Unique. Avec cette option, vous pouvez choisir d’ignorer les ZDL ne contenant qu’une seule ZDE.

L’export Netex Générique :

NeTEx (Network Exchange) est un format de référence pour échanger des données d’offre théorique du transport collectif, défini au niveau européen.

...

  • Les Lignes exportées. Comme pour l’export GTFS, vous pouvez choisir d’exporter les lignes selon le fournisseur de ligne, le transporteur ou selon une liste de ligne que vous définissez.

...

L’export Ara :

Si vous alimentez Ara à partir des données inscrit dans Chouette, vous pouvez sélectionner le type d’export Ara. Lors de l’export, un fichier csv se crée contenant les différents attributs de votre export. Dans le fichier csv, chaque ligne correspond aux informations d’un attribut :

...

  • Les lignes exportées. Vous pouvez choisir d’exporter les lignes selon le fournisseur de ligne, le transporteur ou selon une liste de lignes que vous définissez.

Destination de la publication

Une Publication de données intégrant un export complet peut inclure différents types de destination de publication. L’export est envoyé à la(aux) destination(s) que vous paramétrez.

Destination de type API de Publication

Vous pouvez paramétrer que votre publication ait pour destination une API.

...

Une même API peut être alimentée par plusieurs Publications. La contrainte (actuelle) est que chaque Publication doit utiliser un format d’export différent.

...

Destination de type Notification Email

Vous pouvez choisir une destination email pour votre publication. Vous avez la possibilité de :

  • mettre l’export en pièce-jointe

  • inclure un lien vers une API de Publication

  • choisir les destinataires de ce mail

  • rédiger le contenu du mail

...

Destination de type Ara SaaS

Le type de destination Ara SaaS paramètre votre publication en destination d’un référentiel Ara.

Pour ce faire, vous devez renseigner l’URL du Referential Ara de destination souhaité et le Token d’identification.

...

Destination de type Google Cloud Storage

L’utilisateur peut choisir le type de destination Google Cloud Storage.

Vous devez renseigner le projet, le bucket et la clé secrète de votre espace Google Cloud Storage. Le fichier publié sera donc automatiquement envoyé vers le bucket que vous définissez.

...

Destination de type SFTP

L’utilisateur peut choisir le type de destination SFTP.

...

  • L’Hôte avec l’URL du serveur

  • le Port

  • le Répertoire où le fichier publié sera envoyé

  • la clé secrète du serveur

...

Consultation d’une publication

Les détails d’une Publication rassemble :

...

Sous ces informations, la liste des derniers rapports de cette Publication est présentée.

...

Pour chaque Publication, la liste comprend Source de publication, Chouette crée un rapport intégrant :

  • Le nom de l’offre qui a été publiée, avec un lien vers le rapport de publication

  • L’état final de cette Publication

  • La date de démarrage et de fin de cette Publication

La roue dentée propose l’action « Consulter».

Aucune information telle que des mots de passe ou des clés privées n’est visible ou accessible dans cette page.

Rapport d’une publication

Pour chaque Publication, Chouette crée un rapport intégrant :Chaque rapport de publication est accessible en cliquant sur le nom de la source, ou “Consulter” via la roue dentée. Sur cette page, vous trouverez les détails de la publication en question.

Un bloc “Informations” avec:

  • l'état de la publication

  • le nom de la publication

  • les données sources utilisées le nom de l’offre utilisée pour créer la publication

...

  • avec son lien

Un bloc “Traitement” avec :

  • La date de création de la publication

  • La date de début du traitement de la publication

  • La date de fin de traitement de la publication

  • La durée de l’opération

Un bloc “Export” avec :

  • Le nom de l’export avec un lien pour accéder au téléchargement du fichier

  • Le type d’export

  • L'état de l’envoi vers la destination

  • Les paramètres de l’export

Un rapport d’envoi vers les destinations liées à cette publication :

  • Le type d’envoi

  • le nom court de la destination

  • L'état de l’envoi vers la destionation destination

  • Message d’erreur

  • Le début de la transmission

  • La fin de la transmission

  • la durée de l’opération

...

...

Aucune information telle que des mots de passe ou des clés privées n’est visible ou accessible dans cette page.

Gestion des APIs de Publication

L’utilisateur membre de l’organisation propriétaire du Groupe de Travail peut consulter les APIs de publications qui sont définies au niveau du Groupe de Travail.

...

Lors de la création d’une API, vous pouvez cocher l’option « API publique » pour désactiver l’authentification lors des accès à une API de Publication. Dans ce cas les données publiées via l’API peuvent être téléchargées librement.

Accès à la page publique de votre API de Publication

Dès que vous créez une API de publication (publique ou privée), vous pouvez transmettre à vos consommateurs de données une page publique décrivant toutes les ressources que vous mettez à leur disposition

...

Accès aux données d’une API de Publication

Pour chaque Publication utilisant un export complet et ayant comme destination une API de Publication, celle-ci donne accès aux données de l’export en mettant à disposition le fichier exporté sur une URL de la forme : /api/v1/datas/<nom court>.<format>.zip

...

Lorsqu’une Publication met à disposition des données, les données accessibles via l’API sont mises à jour, mais l’URL reste inchangée.

Publique

Dans le cas d’une API de publication publique, n’importe quel consommateur peut accéder aux données publiées.

Privée

Dans le cas d’une API de publication privé, elle est accessible uniquement si la requête de consultation utilise l’une des clés associées à l’API de Publication. Le token de clé doit être inclus dans une entête HTTP de la forme Authorization: Token token=<token>.

...

Vous pouvez définir un nom à la clé d’accès précisant par exemple quel est le consommateur associé. Le token ou jeton d’accès est généré automatiquement par Chouette.

Récupération des données d’une API par requêtes

La description et l’utilisation de l'API de publication est disponible dans de nombreux langages via notre documentation Postman.

...