Documentation technique

Accueil / Documentation technique / Offre Open Data

Offre Open Data

Consultez la liste des spécificités des fonctionnalités Open Data de la plate-forme.

L’unité d’information de la plate-forme Apidae est l’objet touristique. Chaque objet est composé d’une abrborescence de champs contenant les données qui le constitue.

L’offre Open Data a pour vocation de fournir accès à une partie de ces données. Elle met à disposition une partie des objets touristiques de la plate-forme, avec une partie de leurs champs.
À l’exception des points cités ci-dessous, l’offre Open Data possède un mode de fonctionnement similaire à l’offre complète. Vous pouvez par conséquent exploiter la documentation technique de la plate-forme Apidae pour vos développements, et les développements réalisés pour l’offre Open Data restent valables en cas de changement d’offre.

Filtrage des objets touristiques

Les objets touristiques ne sont pas tous disponibles avec l’offre Open Data. Seule une partie de la base de données Apidae est accessible.
Le tableau ci-dessous résume le filtrage effectué selon le type d’objet touristique :

Type de l’objet Présent dans l’offre Restrictions
Activité Oui  
Commerce et service Oui Limité aux artisants d’art, aux offices du tourisme et aux prestataires d’activités sportives ou culturelles.
Dégustation Oui  
Domaine skiable Oui  
Équipement Oui  
Fête et manifestation Oui Limité aux marchés et aux brocantes
Hébergement collectif Oui  
Hébergement locatif Non  
Hôtellerie Oui  
Patrimoine culturel Oui  
Patrimoine naturel Non  
Restauration Oui  
Séjour packagé Non  
Structure Non  
Territoire Non  

Filtrage des champs

De la même manière que les objets touristiques sont filtrés, seuls certains champs des objets ont été retenus pour apparaître dans l’offre Open Data. Certains champs sont disponibles pour tous les types d’objets, d’autres sont spécifiques selon le type.
Le tableau ci-dessous résume le filtrage effectué sur les champs des objets touristiques par type :

Type de l’objet

Champ disponibles

Dénomination technique des champs
Pour tous les types d’objets

Nom de l’objet
Descriptif court

nom
presentation.descriptifCourt

Adresse postale
Sites Web
Adresses mail
Pages de réseaux sociaux

localisation.adresse
informations.moyensCommunication
Dates d’ouverture ouverture.periodeEnClair
ouverture.periodesOuvertures
ouverture.fermeturesExceptionnelles
datesOuverture
Géolocalisation localisation.geolocalisation.longitude
localisation.geolocalisation.latitude
localisation.geolocalisation.altitude
localisation.geolocalisation.valide

Propriétaire de l’information
Date de mise à jour de l’information
Lien vers le site web du propriétaire

gestion
> Documentation sur la source de l’inforamtion

Activité

Types d’activités sportives et culturelles

informationsActivite.activitesSportives
informationsActivite.activitesCulturelles

Commerce et service

Types d’artisanats

informationsCommerceEtService.typesDetailles

Dégustation

Types de produits

informationsDegustation.typesProduit

Domaine skiable Types d’équipements
Types d’activités
informationsDomaineSkiable.classification
informationsDomaineSkiable.domaineSkiableType
Équipement

Types d’activités

informationsEquipement.activites
Fête et manifestation Types de marchés ou de brocantes informationsFeteEtManifestation.categories
Hébergement collectif Types d’hébergements
Classement de l’hébergement
informationsHebergementCollectif.hebergementCollectifType
informationsHebergementCollectif.classementPrefectoral
informationsHebergementCollectif.chaineEtLabel
informationsHebergementCollectif.labels
informationsHebergementCollectif.agrements
Hôtellerie informationsHotellerie.hotellerieType
informationsHotellerie.classement
informationsHotellerie.labels
informationsHotellerie.chaines
Hôtellerie de plein air informationsHotelleriePleinAir.hotelleriePleinAirType
informationsHotelleriePleinAir.classement
informationsHotelleriePleinAir.chaines
informationsHotelleriePleinAir.labels
Patrimoine culturel   informationsPatrimoineCulturel.patrimoineCulturelType
informationsPatrimoineCulturel.themes
informationsPatrimoineCulturel.categories
Restauration Spécialités culinaires informationsRestauration.specialites

 

Recherches et sélections

Lors de la constitution de vos recherches intuitves ou avancées, un critère limitant les résultats à l’offre Open Data est automatiquement ajouté. Vous pouvez le supprimer si vous désirez consulter de manière plus large l’offre Apidae. Toutefois, ce filtrage sera automatiquement appliqué lors de vos exploitations des services de diffusion Apidae (API ou exports).

Ces filtres sont disponibles et désactivables aux emplacements suivants :

open-data-recherche-intuitive open-data-recherche-avancee

Outils développeurs

L’interface des outils développeurs de la plate-forme Apidae permet de consulter le format de sérialisation des objets touristiques (au format JSON pour les API , au format XML ou JSON pour les exports).
Sur ces pages, la consultation de la sérialisation des objets se fait en mode standard ou en mode Open Data en fonction de la configuration du projet sélectionné.

Export d’un projet

Il existe de légères différences entre le contenu d’une archive d’export standard et le contenu d’une archive d’export Open Data. L’export des données Open Data ne contiendra pas les informations suivantes :

  • les objets liés : les objets liés et les structures de gestion et d’information n’étant pas disponibles avec l’offre Open Data, vous ne trouverez pas de dossier objets_lies, ni de fichier objets_lies_supprimes.json dans l’archive d’export.
  • les territoires : les territoires n’étant pas disponibles avec l’offre Open Data, vous ne trouverez pas le fichier territoires.json dans l’archive d’export.
  • les critères internes

Migration vers l’offre complète

Lors du passage d’une offre Open Data à une offre complète, il est nécessaire de purger vos données et avant de les réimporter complètement, afin de voir apparaître les objets et les champs auparavant filtrés.

exports Pour les utilisateurs des exports, il est nécessaire de procéder à une réinitialisation, depuis l’interface des operations exceptionnelles d’export.