Voici la liste des services accessibles aux projets de diffusion API Apidae.
Objet touristique
Le schéma JSON d’un résultat de requête est disponible sur cette page.
Ces services permettent de récupérer les informations d’un seul objet touristique de manière simple.
- v002/objet-touristique/get-by-id – récupération par id
- v002/objet-touristique/get-by-identifier – récupération par identifier
L’existence d’un identifiant / id et d’un identifier est un héritage historique de Apidae. Les deux peuvent être utilisés. Nous conseillons d’utiliser le champ id.
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.
- v002/recherche/list-identifiants/ – récupération d’une liste d’identifiants
- v002/recherche/list-objets-touristiques/ – récupération d’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 :
- v002/agenda/simple/list-identifiants/ – récupération d’une liste d’identifiants
- v002/agenda/simple/list-objets-touristiques/ – récupération d’une liste d’objets
> 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/09/2012 au 07/09/2012,
Fete_Et_Manifestation_2 se déroulant du 06/09/2012 au 10/09/2012
Une recherche agenda détaillé du 05/09/2012 au 08/09/2012 nous renverra un résultat de la forme :
05/09/2012 : Fete_Et_Manifestation_1
06/09/2012 : Fete_Et_Manifestation_1, Fete_Et_Manifestation_2
07/09/2012 : Fete_Et_Manifestation_1, Fete_Et_Manifestation_2
08/09/2012 : 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 :
- v002/agenda/detaille/list-identifiants/ – récupération d’une liste d’identifiants
- v002/agenda/detaille/list-objets-touristiques/ – récupération d’une liste d’objets
Documentation du format de la requête
Consultation du référentiel
Le référentiel complet est mis à disposition (en statique) sur ces URL :
- http://static.apidae-tourisme.com/filestore/exports-referentiel/communes.json
- http://static.apidae-tourisme.com/filestore/exports-referentiel/elements_reference.json
Ils sont mis à jour chaque nuit, si les référentiels communes ou des éléments de références (critères) ont évolué.
Les services suivants sont également à votre disposition pour récupérer les éléments du référentiel de façon unitaire :
- v002/referentiel/communes/ – récupération de communes
- v002/referentiel/elements-reference/ – récupération d’éléments de référence
- v002/referentiel/criteres-interdits/ – interdictions entre éléments de référence
- v002/referentiel/criteres-internes/ – récupération de critères internes
- v002/referentiel/selections/ – récupération de sélections
- v002/referentiel/selections-par-objet/ – récupération de sélections par objet touristique
Ces services ne sont pas conçus pour obtenir l’intégralité du référentiel, mais uniquement pour récupérer de petits ensembles d’éléments que vous aurez au préalable identifiés.
Consultation des membres
Ces services ne sont accessibles qu’avec des niveaux de droits élevés. Merci de nous consulter pour tout besoin.
Ces services sont à votre disposition pour récupérer les membres :
- v002/membre/get-by-id/ – récupération d’un membre à partir de son identifiant
- v002/membre/get-membres/ – recherche d’un membre
Consultation des utilisateurs
Ces services ne sont accessibles qu’avec des niveaux de droits élevés. Merci de nous consulter pour tout besoin.
Ces services sont à votre disposition pour récupérer les utilisateurs :
- v002/utilisateur/get-by-id/ – récupération d’un utilisateur à partir de son identifiant
- v002/utilisateur/get-by-mail/ – récupération d’un utilisateur à partir de son adresse email
- v002/utilisateur/get-by-membre/ –récupération des utilisateurs d’un membre
- v002/utilisateur/get-all-utilisateurs/ – récupération de la liste complète des utilisateurs