Clés API Apidae : créer le projet et la sélection pour son site

Pour qu’un site WordPress affiche des fiches Apidae, il lui faut trois choses venues d’Apidae : un projet, l’identifiant et la clé API de ce projet, et au moins une sélection calculée. Ce guide suit l’ordre dans lequel un office de tourisme ou son agence les prépare, jusqu’à la saisie dans WP-Apidae et au premier import.

Avant de commencer : qui fait quoi

Les projets se gèrent sur base.apidae-tourisme.com, dans le menu Diffuser, rubrique Mes projets. Selon la documentation développeurs d’Apidae, un projet de diffusion est créé par le membre propriétaire du contenu, en général l’office de tourisme. S’il confie son site à une agence, il l’invite ensuite sur le projet et choisit ce qu’elle peut faire :

• consulter le projet ;
• modifier sa configuration technique ;
• modifier son contenu, c’est-à-dire ajouter, modifier ou supprimer des sélections.

Si elle monte le site, accordez-lui les deux derniers : ils évitent les allers-retours.

Un cas à part : si les données appartiennent à un autre propriétaire et vous sont ouvertes par l’API de consentement d’Apidae, le parcours n’est pas le même. Il est décrit dans notre article sur l’API de consentement Apidae. La suite concerne un projet classique.

Étape 1 : créer le projet du site

1. Connectez-vous à votre compte sur base.apidae-tourisme.com.
2. Ouvrez Diffuser, puis Mes projets, et créez un nouveau projet de diffusion.
3. Donnez-lui un nom qui permette de le retrouver : celui du site suffit.
4. Si une agence réalise le site, invitez-la sur ce projet avec les accès décrits plus haut.

Un site correspond en général à un projet. Garder un projet par site permet de régler chacun séparément et de savoir à tout moment quel site utilise quelle clé.

Pour un premier essai, Apidae propose aussi un projet de test, limité en nombre d’objets, que le prestataire peut créer lui-même depuis la liste des projets.

Étape 2 : régler la configuration technique

Dans le projet, ouvrez l’onglet Configuration technique et passez-le en modification. Pour WP-Apidae, la documentation demande :

• Technologies utilisées : API ;
• Fréquence de génération : Quotidien ;
• Format : JSON ;
• Version du format de sortie : V2 ;
• Exporter les dates d’ouverture : coché.

Apidae recommande par ailleurs de laisser décochée l’option qui inclut les objets masqués : sans elle, seules les fiches publiées sont diffusées.

Les cases Temps réel et Webhook font arriver sur le site les modifications faites dans Apidae, sans attendre la synchronisation planifiée. Vous pouvez y revenir plus tard : l’adresse à coller dans le champ Webhook est fournie par WP-Apidae, sous la forme https://votre-site.fr/wp-json/wp-dae/v1/apidae/update. Côté extension, le temps réel est désactivé par défaut et s’active dans Réglages, onglet Connexion Apidae.

Étape 3 : récupérer l’identifiant du projet et la clé API

Toujours dans le projet, l’onglet Informations générales affiche les deux valeurs dont le site a besoin :

• l’identifiant du projet, un nombre (par exemple 1234, valeur fictive) ;
• la clé API, une suite de caractères propre à ce projet (par exemple cle-exemple-0000, valeur fictive elle aussi).

Notez-les sans les mélanger : une clé collée dans le champ de l’identifiant, ou l’inverse, est l’une des causes les plus fréquentes d’une connexion refusée.

La clé API se garde comme un mot de passe. Elle n’a rien à faire dans une capture d’écran publiée ni dans un dépôt de code public. Transmettez-la à votre agence par un canal privé, ou donnez-lui l’accès au projet pour qu’elle la lise elle-même.

Étape 4 : créer une sélection

Une sélection regroupe les objets que le projet diffuse : les hébergements d’une commune, les manifestations de la saison, les itinéraires à vélo. Elle se définit dans le projet à partir de critères, puis Apidae la calcule.

1. Dans votre projet, ouvrez la partie consacrée aux sélections et créez-en une nouvelle.
2. Donnez-lui un nom parlant : c’est ce nom qui s’affichera dans WP-Apidae au moment de l’import.
3. Définissez ses critères, puis enregistrez.
4. Attendez le calcul. Une sélection qui vient d’être créée ne remonte qu’une fois calculée. La liste Mes projets indique la date du dernier calcul des sélections de chaque projet.

Construisez vos sélections d’après les listes que le site affichera. Le tri plus fin (par type, par taxonomie) se fait ensuite dans WordPress, avec les options des blocs Listing et les groupes de filtres.

Étape 5 : saisir l’identifiant et la clé dans WP-Apidae

Une fois l’extension installée et activée (voir Commencer avec WP-Apidae), WP-Apidae n’affiche que son écran de configuration initiale et son diagnostic, tant qu’aucune connexion n’est enregistrée.

1. Dans l’administration WordPress, ouvrez WP-Apidae, écran Configuration.
2. Renseignez Identifiant du projet et Clé API avec les valeurs de l’étape 3.
3. Laissez Consentement API désactivé. Cette option ne s’active que si vous utilisez le service de consentement d’Apidae.
4. Cliquez sur Sauvegarder les modifications.

L’extension teste alors la connexion auprès d’Apidae avant d’enregistrer quoi que ce soit. Si Apidae accepte, les valeurs sont enregistrées et vous arrivez sur les réglages. Si Apidae refuse, un message d’erreur s’affiche et rien n’est enregistré : vérifiez la clé, l’identifiant et le mode de consentement, puis recommencez.

Après l’enregistrement, la connexion est figée : Réglages, onglet Connexion Apidae, affiche l’identifiant et la clé en lecture seule, et la case Consentement API ne se modifie plus depuis l’interface. Vérifiez donc le projet et le mode avant de valider.

Profitez de votre passage dans les réglages pour cocher, dans l’onglet Objets touristiques, les types d’objets que vos sélections contiennent : ce réglage est commun à tout le site, et un type non coché n’est pas importé.

Étape 6 : importer la sélection

1. Ouvrez WP-Apidae, puis Sélections, et cliquez sur Importer une sélection.
2. L’extension interroge Apidae avec votre clé et affiche toutes les sélections du projet, avec leur nom, leur identifiant Apidae et leur nombre de fiches. Vous n’avez aucun identifiant de sélection à recopier.
3. Cliquez sur Importer à côté de la sélection voulue.
4. Si une sélection que vous venez de créer manque à la liste, cliquez sur Mettre à jour les sélections.

L’import tourne en arrière-plan : vous pouvez continuer à travailler dans l’administration pendant qu’il avance. La colonne Fiches importées / Total de l’écran Sélections suit sa progression. Ensuite, une synchronisation planifiée reprend les modifications d’Apidae toutes les 2 heures par défaut. L’intervalle se règle de 2 à 24 heures dans l’onglet Connexion Apidae.

Si quelque chose bloque

• Connexion refusée : l’identifiant et la clé sont peut-être inversés, ou la case Consentement API a été activée pour un projet classique.
• Aucune sélection dans la liste : le projet n’en contient pas encore, ou leur calcul n’a pas eu lieu. Vérifiez la date du dernier calcul dans Mes projets.
• Une famille de fiches absente : le type d’objet correspondant n’est pas coché dans l’onglet Objets touristiques.

Si le problème persiste, l’onglet Diagnostic des réglages produit un rapport à joindre à votre demande de support. Il ne contient ni mot de passe, ni clé API en clair, ni contenu de fiche.

Pour la suite

• Options de réglages : fréquence, langues, temps réel, images.
• Importer une sélection : l’import et la resynchronisation en détail.
• Afficher mes sélections : poser les fiches dans vos pages.

Pour découvrir l’extension elle-même et ses modules, voyez la page WP-Apidae, le plugin WordPress pour Apidae.