Service de consentement

Voici la liste des services accessibles aux services de consentements.

Le fonctionnement des services ci-dessous reste le plus proche possible des services classiques des API auxquels viennent s’ajouter les spécificités du servi ce de consentement.

Attention, sur le service de consentement, certains paramètres sont spécifiques :

  • La profondeur de la donnée est gérée par le créateur du projet. Seuls les champs autorisés sont disponibles au sein de ces services. Les champs possibles sont mentionnés dans les retours API dans le nœud query.responseFields.
  • Le domaine api.plateforme.apidae-tourisme.com est différent du domaine utilisé pour les autres appels
  • projetId de la forme 9fd02c13-42e7-534f-955g-4333d3071c80
  • apiKey de la forme f399cf0b-c557-6609-be75-1337d388a404
  • searchId de la forme 4023139e-d512-4265-c0f5-20887a503g7f

Liste des recherches associées au service de consentement

Ce service permet de récupérer la liste des recherches associées au service de consentement.

Objet touristique

Le schéma JSON d’un résultat de requête est disponible sur cette page.

Ce service permet de récupérer les informations d’un seul objet touristique de manière simple.

Objets touristiques enrichis

Ce service permet de récupérer un objet touristique ainsi que les données enrichies liées à l’objet.

Recherche d’objets touristiques

Le schéma JSON d’un résultat de requête est disponible sur cette page.

Ces services permettent de récupérer les objets touristiques respectant une requête de recherche. Les deux services utilisent le même format de requête. La sortie propose soit une liste d’identifiants, soit une liste d’objets.

Documentation du format de la requête

Agenda

Ces services fonctionnent de manière similaire aux services de recherche d’objets touristiques précédents. Seuls les objets de type « Fête et manifestation » et « Activité » sont pris en compte par ce type de recherche.

Il existe deux modes de recherche agenda : un mode simple et un mode détaillé.

Mode simple

En mode simple, les objets touristiques retournés sont automatiquement triés par date de début de l’évènement.

Il existe deux services, l’un pour récupérer les identifiants des objets, l’autre pour récupérer les objets eux-mêmes :

Documentation du format de la requête

Mode détaillé

Les objets sont regroupés par date d’évènement. Un objet touristique qui se déroule sur plusieurs journées est listé plusieurs fois dans le résultat (une fois pour chaque jour d’ouverture).

Prenons l’exemple de deux événements :

Fete_Et_Manifestation_1 se déroulant du 04/06/2022 au 07/06/2022,
Fete_Et_Manifestation_2 se déroulant du 06/06/2022 au 10/06/2022

Une recherche agenda détaillé du 05/06/2022 au 08/06/2022 nous renverra un résultat de la forme :

05/06/2022 : Fete_Et_Manifestation_1
06/06/2022 : Fete_Et_Manifestation_1, Fete_Et_Manifestation_2
07/06/2022 : Fete_Et_Manifestation_1, Fete_Et_Manifestation_2
08/06/2022 : Fete_Et_Manifestation_2

Comme pour la recherche d’objets classique, il existe deux services, l’un pour récupérer les identifiants des objets, l’autre pour récupérer les objets eux-mêmes :

Documentation du format de la requête