Sujet précédent

Paramètrages de Groupes de travail

Sujet suivant

Centre de Support

Publications

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.

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.

Vous pouvez consulter les publications actuellement définies. Il vous est possible de filtrer suivant le type d’export, ainsi que de trier par nom de la publication et le type.

La roue dentée de chaque ligne permet de consulter, éditer ou supprimer (avec confirmation) la publication.

La gestion des publications est accessible via le menu « Paramétrages » - « Publications ».

_images/publication_list.png

L’utilisateur autorisé et membre de l’organisation propriétaire du Groupe de Travail peut créer et modifier une Publication de données.

Pour chaque Publication, vous pouvez définir :

  • le nom de la Publication (pour mieux identifier son rôle)
  • si la Publication est active ou non. Les publications désactivées sont ignorées.
  • le type et les paramètres de l’export qui doit être réalisé à chaque Publication
  • les destinations et leurs paramètres qui doivent ensuite prendre en charge les données exportées

Vous pouvez ajouter et supprimer des destinations.

L’utilisateur membre de l’organisation propriétaire du Groupe de Travail peut consulter les publications définies ainsi que les détails d’une Publication.

Les détails d’une Publication rassemble :

  • un bloc “Informations” avec le nom de la Publication et sa date de création et de modification
  • un bloc “Paramètres de l’Export” avec le type de l’export réalisé à chaque Publication et les paramètres de cet export
  • un bloc “Destination”, avec pour chaque Destination le type de la Destination et les paramètres de la Destination

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

_images/publication_page.png

Pour chaque Publication, la liste comprend :

  • 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éé un rapport. Ce Rapport intègre :

  1. Un bloc “Informations” avec:
  • le nom et le lien vers l’offre qui a été publiée
  • l’état final de la Publication
  • la date de démarrage et de fin de cette Publication
  1. Un résumé de l’opération d’Export réalisé au moment de la Publication avec :
  • le nom de l’export avec un lien pour consulter les détails de l’opération d’export
  • le type d’export
  • la date de démarrage et de fin de cet Export
  1. Un résumé des Destinations qui ont pris en charge les données publiées, avec pour chaque Destination :
  • le nom de la Destination
  • le type de Destination
  • l’état de la soumission à cette Destination
  • la date de démarrage et de fin de la soumission à cette Destination

Transmettre une publication avec un export complet vers une Destination de type API de Publication

Une Publication de données intégrant un export complet peut inclure une Destination de type API de Publication.

A chaque Publication, l’API de Publication est informée que les données qui doivent être transmises pour le format de la publication (le format choisi pour l’export) sont maintenant les données exportées par cette Publication.

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.

Géstion 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. Si vous disposez des permissions requises, vous pourrez gérer ces APIs de Publications.

Plusieurs APIs de Publication peuvent être définies au sein du Groupe de Travail. Chaque peut être la destination de plusieurs Publications de données. Cette souplesse permet de diffuser l’offre du Groupe de Travail sous plusieurs formats, plusieurs modalités (durée de l’offre, etc) en gérant des accès aux niveaux de chaque API.

Vous pouvez consulter les APIs de Publication actuellement définies.

_images/api_list.png

La roue dentée de chaque ligne permet de consulter, éditer ou supprimer (avec confirmation) l’API de Publication.

La gestion des publications est accessible via le menu « Paramétrages » > « Publications » > « APIs de Publication ».

L’utilisateur autorisé et membre de l’organisation propriétaire du Groupe de Travail peut créer et modifier une API de Publications.

Vous pouvez définir:

  • un nom, qui sera présent dans Chouette, et en externe.
  • un nom court (ou nicename), correspond au nom utilisé dans l’URL de l’API. Le nom court « acmee » produira, par exemple, des URLs comme /api/v1/datas/acmee.gtfs.zip.

L’URL publique se met à jour en fonction du nom court, au fur et à mesure que vous remplissez ce champ.

En cliquant sur “Valider”, Chouette crée une API de Publication, vous arrivez sur la page de consultation de cette API.

L’utilisateur membre de l’organisation propriétaire du Groupe de Travail peut consulter le paramétrage d’une API de Publication.

Les détails d’une API de Publication intègrent :

  1. Les informations, avec :
  • le nom
  • le nom court
  • l’URL publique
  • les dates de création et de dernière modification
  1. Les publications associées, avec, pour chacune :
  • le nom avec un lien vers le dernier rapport de publication (qui a alimenté cette API),
  • le type d’export
  1. Les clefs d’accès, avec, pour chacune :
  • le nom
  • le token, ou jeton d’accès
  • les dates de création et de dernière modification
_images/api_page.png

L’utilisateur avec les permissions requises peut créer, modifier, ou supprimer chaque clé d’accès.

Les clés d’accès peuvent être confiées à des tiers pour leur donner un accès à toutes les données publiées par l’API. Dès qu’une clé est supprimée, l’accès n’est plus possible. Vous pouvez ainsi confier des clés différentes à chaque tiers et gérer finement les droits d’accès et leur révocation.

Par défaut, quand l’API vient d’être créée, il n’y a pas encore de clé d’accès. Il n’y a donc pas de tableau, mais un texte d’aide : « Cette API ne dispose pas encore de clé d’accès. »

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 à une page d’accueil dans l’API de Publication

Vous pouvez accèder à une page d’accueil depuis l’API de Publication, en cliquant sur l’URL publique.

Sur la page d’accueil d’API vous pouvez apprendre comment se connecter à cette API.

_images/api.png

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

Les URLs des APIs de Publication ne sont accessibles que 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>’.

L’utilisateur autorisé peut créer une clé d’accès d’API de Publication depuis les détails d’une API de Publication.

Vous pouvez définir un nom à la clé d’accès. Le token ou jeton d’accès est généré automatiquement par Chouette.

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

Par exemple, pour une API avec le nom court « test », on pourra accéder aux données via les URLs :

  • /api/v1/datas/test.netex-idfm.zip
  • /api/v1/datas/test.netex-full.zip
  • /api/v1/datas/test.gtfs.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.