Documentation technique

Consultation

Fonctionnement général

Une métadonnée est une donnée au format JSON qui peut être attachée à un objet touristique, à destination d’une cible particulière.

Noeud

Chaque métadonnées est rattachée a un noeud appartenant à un membre. Vous ne pouvez ajouter des métadonnées que sur un noeud appartenant à votre membre.

La création de nouveaux noeuds est contrôlée par le réseau Apidae. Pour demander la création d’un noeud pour votre membre, veuillez vous adresser à votre animateur Apidae.

Cible

Une métadonnées est destinée à une cible particulière. Cette cible peut être de différent types :

  • GENERAL : la métadonnée est à portée générale. N’importe quel projet récupérant l’objet touristique peut avoir accès à cette métadonnée.
  • MEMBRE : la métadonnée est destinée à un membre en particulier. N’importe quel projet appartenant à ce membre peut avoir accès à cette métadonnée.
  • PROJET : la métadonnée est destinée à un projet en particulier.

Donnée JSON

Le format des données n’est pas contrôlé par l’application lors de l’enregistrement d’une métadonnée. L’application s’assure seulement que la métadonnée envoyée a bien une structure JSON correcte, sans se soucier de son contenu.

Lecture des métadonnées

 La lecture des métadonnées se fait via les API et les exports.

Les métadonnées d’un objet touristique se trouvent dans le champ metadonnees. Ce champ contient une liste de noeuds. Sur chaque noeud, le champ contenu contient la liste des métadonnées qui vous sont adressées par le noeud.

Les métadonnées sont intégrées directement dans le flux, au format JSON, afin d’être immédiatement exploitables par les projets.

Les métadonnées sont destinées à permettre l’interconnexion avec d’autres bases de données. Les informations mises à disposition sont généralement des identifiants ou des informations sommaires permettant la consultation de services extérieurs à Apidae. Les formats de ces données sont déterminés et maintenus par leurs fournisseurs.

Exemple de méta-données :

"metadonnees" : [ {
    "noeudId" : "alliance-reseaux-commercialisation",
    "contenus" : [ {
      "cible" : "general",
      "metadonnee" : {
        "info 1" : "contenu de l'info 1",
        "info 2" : "contenu de l'info 2",
        "info 3" : {
          "info 3.1" : "contenu de l'info 3.1",
          "info 3.2" : "contenu de l'info 3.2"
        }
      }
    }, {
      "cible" : "projet_1",
      "metadonnee" : {
        "info 1" : "contenu de l'info 1 pour le projet 1",
        "info 2" : "contenu de l'info 2 pour le projet 1",
        "info 3" : {
          "info 3.1" : "contenu de l'info 3.1 pour le projet 1",
          "info 3.2" : "contenu de l'info 3.2 pour le projet 1"
        }
      }
    } ]
  } ]

Les métadonnées qui vous sont destinées, apparaissent également dans les outils de sérialisation des outils développeurs (voir les outils développeurs).