Créer son projet numérique
Découvrez comment déclarer un site web, une application, une borne ou tout autre projet numérique utilisant les données Apidae, puis configurer son fonctionnement.
À retenir
- Toute création de projet est soumise à la validation d’un référent Apidae.
- Les nouveaux projets sont désormais limités aux sélections : les API de consultation permettent uniquement de récupérer les offres présentes dans les sélections du projet, ainsi que certains objets qui leur sont associés.
- Si vous souhaitez uniquement tester les flux, créez plutôt un projet de test.
À quoi sert un projet numérique ?
Le point de connexion entre Apidae et votre outil
Le projet numérique permet de déclarer l’usage des données Apidae pour un site, une application, une borne, un widget ou un autre service, puis de définir les sélections et les paramètres techniques utilisés pour l’alimenter.
Créer le projet
Dans le menu principal, rendez-vous dans Diffuser / Projets / Mes projets.
1
Cliquez sur Créer
Depuis l’écran Mes projets, cliquez sur le bouton Créer.
2
Choisissez le type de projet
Sélectionnez le type correspondant à votre besoin, puis cliquez sur Suivant.
3
Renseignez le formulaire
Décrivez précisément votre projet avant d’enregistrer votre demande.
Renseigner les informations générales
1 · Nom du projet
Utilisez un nom facilement identifiable
Pour un site web, indiquez de préférence son nom de domaine (exemple : www.monsiteweb.com).
Pour les autres projets, utilisez un nom explicite associant le type de projet et son nom (exemple : Application mobile – Mon appli).
2 · Type de projet
Précisez l’usage prévu
Sélectionnez la catégorie correspondant au service alimenté : site web, application, widget, borne ou autre usage proposé dans le formulaire.
3 · État du projet
Indiquez son niveau d’avancement
En développement : le service numérique est encore en phase de construction ou de recette.
En production : le service numérique est opérationnel.
4 · Description
Présentez précisément votre projet
Indiquez ses objectifs, ses publics, les services proposés, les types d’objets Apidae utilisés et sa place dans votre stratégie numérique.
Cette description facilite la validation du projet et les échanges avec les autres membres du réseau travaillant sur des usages similaires.
Lorsque le formulaire est complet, cliquez sur Enregistrer pour créer le projet et transmettre la demande de validation.
Faire valider le projet
Après l’enregistrement, le projet doit être validé par votre animateur Apidae ou par la coordination globale du réseau.
1
Projet créé
Les informations générales sont enregistrées et le projet apparaît dans votre liste.
2
En attente de validation
Vous pouvez préparer vos filtres et vos sélections, mais les sélections ne sont pas encore calculées et aucun export n’est généré.
3
Projet validé
Le prestataire technique peut utiliser les flux selon la configuration et le contenu autorisés dans le projet.
💡 Pendant l’attente
Profitez de cette étape pour créer les sélections qui alimenteront votre projet et vérifier qu’elles contiennent bien toutes les offres nécessaires.
Dans quels cas le projet peut-il ne pas être validé ?
- Le formulaire est incomplet ou insuffisamment renseigné.
- Le type de projet ou la fonctionnalité demandée n’est pas adapté à l’usage décrit.
Naviguer dans la fiche détaillée du projet
Une fois le projet créé, sa fiche détaillée centralise les informations, le contenu et les outils nécessaires à son suivi.
Configurer techniquement le projet
Ouvrez l’onglet Configuration technique, puis cliquez sur le pictogramme en forme de crayon pour modifier les paramètres accessibles. Cette configuration peut être réalisée par votre structure ou déléguée à votre agence selon les droits accordés sur le projet.
01 Technologies utilisées
Choisissez l’utilisation des API, des exports, ou des deux.
02 Fréquence de génération
Définissez une génération quotidienne, hebdomadaire ou mensuelle des exports.
03 Inclure les objets masqués
Il est recommandé de ne pas les exporter. Si vous activez cette option, veillez à empêcher leur diffusion auprès du public.
04 Format et version
Choisissez le format JSON ou XML. La version de sortie disponible est la V2.
05 Regroupement des objets
Les objets peuvent être regroupés par paquets de 50 ou générés dans des fichiers individuels.
06 Dates d’ouverture
Activez leur export pour obtenir la liste détaillée des jours d’ouverture sur une visibilité d’au moins un an.
07 URL et e-mails de notification
À la fin d’un export, Apidae peut transmettre son résultat à une URL et notifier les adresses renseignées en cas d’erreur. Séparez plusieurs adresses par des espaces, des virgules ou des points-virgules.
08 Adresses IP
Indiquez les serveurs susceptibles de solliciter les ressources Apidae, notamment les multimédias. Cette information facilite l’identification et la prise de contact en cas de blocage.
09 Projet limité aux sélections
Le statut de cette option est visible dans la configuration, mais sa modification est réservée à Apidae.
10 Enregistrement
Enregistrez les paramètres pour appliquer la nouvelle configuration.
Comprendre la limitation aux sélections
Projet limité aux sélections
Cette option est activée sur les nouveaux projets. Elle peut également être activée par Apidae sur des projets déjà existants, ou désactivée au besoin.
Lorsqu’un projet est limité aux sélections, les API de consultation, qu’il s’agisse d’une recherche sous forme de liste ou d’un appel direct par identifiant, permettent uniquement de récupérer :
- les offres présentes dans au moins une sélection du projet ;
- les objets automatiquement associés à ces offres.
Important pour votre site ou votre application
Une offre absente des sélections du projet ne peut plus être récupérée librement par l’API, même lorsque son identifiant est connu.
Vérifiez donc avec votre agence ou votre prestataire technique que toutes les offres utilisées par le service sont bien intégrées à une sélection du projet.
💡 Bon à savoir
Les exports sont déjà construits à partir des sélections. Cette limitation concerne surtout les usages des API de consultation qui permettaient auparavant d’appeler directement d’autres offres de la plateforme.
Utiliser les opérations exceptionnelles
En cas de problème sur votre site, votre application ou votre borne, ou lorsque vous devez actualiser rapidement le contenu du projet, vous pouvez demander un nouveau calcul des sélections.
Cette opération doit rester exceptionnelle
Le calcul normal des sélections et la génération des flux sont automatisés. Une relance manuelle ne doit être demandée que lorsqu’un besoin ponctuel le justifie.
Pour connaître la marche à suivre, consultez l’article Demander le calcul exceptionnel des sélections d’un projet.
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.