Vous trouverez sur cette page, un guide des principales bonnes pratiques à adopter pour utiliser convenablement nos API.
Règle de base : un site = un projet Apidae
Construire les sélections d’objets
Il est fortement recommandé que les Offices de Tourisme gèrent eux-mêmes leurs filtres et sélections. Il conviendra néanmoins de s’assurer que la taille des sélections soit bien limitée aux bons types objet sur la bonne zone géographique.
Même si les API vous proposent des fonctionnalités de recherche, favorisez les sélections d’Apidae pour vos recherches :
- les sélections permettent de répartir la responsabilité entre les contenus (déterminés par votre client via les sélections) et les développements
- les sélections permettent à votre client d’intervenir de manière autonome sur les contenus
- s’il ne désire pas les gérer lui-même, votre client peut vous confier la réalisation de sélections
- les possibilités de requêtage des sélections sont plus avancées que celles de l’API
- les sélections sont pré-calculées pour optimiser les temps de réponse
- il est possible de combiner une sélection avec des critères de recherche API si nécessaire
Plus d’information sur la création de sélection via la doc utilisateur.
Choisir la profondeur des données
Déterminez avec l’office de Tourisme la profondeur de données minimale afin de récupérer uniquement les informations utiles
Bien utiliser les API
Optimisez vos appels :
- Utilisez l’alias @all uniquement pour les tests
- Limitez vos appels aux champs et langues nécessaires
- Si vous n’utilisez pas le temps réel, utilisez des appels différentiels avec l’ID et la dernière date de modification
- Pensez à mettre un timeout : utiliser un timeout trop long peut pénaliser la plateforme Apidae et votre site web, nous vous conseillons de mettre une valeur maximum de 20sec.
Plus d’informations sur le filtrage de données sur la page dédiée de la documentation.
Mise en place de cache
Il est primordial de mettre en place un cache d’au moins 24h pour récupérer les données des objets touristiques et éviter de taper en direct sur nos API et donc sur nos serveurs à chaque page affichée sur votre site internet.
- Stockez les images et fichiers couramment utilisés directement sur votre serveur
- Un cache des images peut suffire si les autres fichiers sont simplement disponibles en téléchargement
- Cachez les résultats pour améliorer les performances
gérer correctement les cas d’erreurs
Apidae se réserve le droit de suspendre et bloquer tout projet sur-sollicitant ses API.
Gérer correctement les cas d’erreurs
Évitez les requêtes en boucle en cas d’erreur
Prévoyez la gestion des erreurs dans votre application pour résister aux coupures de services potentielles
Exploiter tous les services mis à votre disposition
En particulier, pensez à utiliser les services orientés identifiants ; ils sont plus rapides que les services renvoyant les informations des objets touristiques. Une utilisation combinée d’un cache (pour les informations des objets touristiques) et des services de recherche orientés identifiants améliorera vos temps de consultation.
Vous pouvez consulter la liste des services dans la documentation.
Newsletter
Une newsletter dédiée aux fournisseurs de service est régulièrement envoyée. Elle vous permet de suivre les nouveautés et les changements de la plateforme. S’inscrire à la newsletter.