Documentation technique

Format de l'archive

Une archive d’export compile dans un fichier zip l’ensemble des fichiers qui permettent après un traitement différentiel d’exploiter les informations de la base Apidae.

Format de l’archive d’export

L’export produit une archive ZIP contenant toutes les informations relatives au projet. A l’intérieur on trouve deux types de fichiers :

  • ceux qui sont re-générés intégralement à chaque export,
  • ceux qui sont générés par rapport au dernier export réussi. Ces fichiers, que l’on appellera fichiers différentiels, ne contiennent donc que les objets qui ont été ajoutés, modifiés ou supprimés depuis le dernier export.

Fichiers différentiels :

  • objets_modifies, le dossier contenant les fichiers d’export des objets modifiés depuis le dernier export. Ces fichiers se nomment objets_modifies-X.json. Le X indique que le fichier est le X-ième groupe d’objets touristiques, si le prestataire a choisi de grouper les objets touristiques modifiés. Sinon il désigne l’identifiant de l’objet touristique contenu dans le fichier.
  • objets_lies, le dossier contenant les fichiers d’export des objets liés modifiés depuis le dernier export. Ces fichiers se nomment objets_lies_modifies-X.json. Le X indique que le fichier est le X-ième groupe d’objets touristiques, si le prestataire a choisi de grouper les objets touristiques modifiés. Sinon il désigne l’identifiant de l’objet touristique contenu dans le fichier. Les objets déjà présents dans objets_modifies ne sont pas présents dans objets_lies.
  • objets_supprimes.json, contenant la liste des identifiants Apidae des objets supprimés depuis le dernier export.
  • objets_lies_supprimes.json, contenant la liste des identifiants Apidae des objets liés supprimés depuis le dernier export.

Fichiers re-générés intégralement à chaque export :

  • selections.json, contenant la liste des sélections du projet, avec leurs noms et la liste des identifiants Apidae des objets qu’elles contiennent.
  • criteres_internes.json, contenant la liste des critères internes du projet.
  • elements_reference.json, contenant la liste de tous les éléments de référence de l’application Apidae.
  • communes.json, contenant la liste de toutes les communes de l’application Apidae.
  • territoires.json, contenant tous les objets touristiques de type Territoire de l’applications Apidae.

Les fichiers du référentiels peuvent être volumineux, en particulier le fichier des communes. Si cela pose problème pour vos traitement, vous pouvez exploiter les API de consultation du référentiel, en veillant à utiliser un cache.

> Récupération d’éléments du référentiel

Les objets liés

En plus des objets touristiques directement attachés au projet, on exporte également les objets liés. Ce sont :

  • Les structures de gestion des objets touristiques exportés,
  • Les structures d’information des objets touristiques exportés,
  • Les prestataires d’activité des activités exportées,
  • Les organismes de réservation des objets touristiques exportés,
  • Les domaines parents, sous-domaines, et EGP des domaines skiables exportés,
  • Les objets présents dans la section objet liés des objets touristiques exportés.

Les objets déjà exportés dans objets_modifies ne sont pas présents dans objets_lies.

L’export n’est pas récursif ; les objets liés des objets liés ne sont pas inclus dans l’export.

Contenu des fichiers

Les fichiers objets_supprimes.json et objets_lies_supprimes.json sont des listes des identifiants d’objets supprimés depuis le dernier export. Exemple :

[ 258619, 277569, 281612 ]

Pour les autres fichiers d’export, le format des différents types d’informations qu’ils contiennent est détaillé dans la section format JSON de objets touristiques.

Les fichiers multimédia

Les fichiers multimédia sont disponibles à l’adresse indiquée dans la description JSON du fichier multimédia. Ces fichiers peuvent être hébergés soit sur la plate-forme Apidae, soit sur des plate-formes extérieures.

> Documentation sur les multimédias