Notre API ECHO est désormais disponible en format Web et en format OpenAPI (anciennement Swagger).
> https://api.echo.lu/echo.json
Bonnes pratiques d'utilisation
L'API echo.lu est une base de données d'événements destinée à être synchronisée. Ce n'est pas un service de recherche à appeler directement depuis le navigateur à chaque chargement de page.
Architecture recommandée
- Synchronisation côté serveur: votre serveur récupère les événements à venir une à deux fois par jour.
- Stockage local: les événements sont enregistrés de votre côté, en base de données ou en cache.
- Affichage: votre page agenda filtre et trie ces données localement (par jour, catégorie, prochaine occurrence, etc.), sans appel à notre API pendant la navigation de vos visiteurs.
Pourquoi cette approche ?
- Sécurité: votre clé API n'est jamais exposée dans le navigateur.
- Performance: vos pages se chargent plus vite, sans dépendre d'un appel réseau externe.
- Fiabilité: votre agenda reste disponible même en cas d'indisponibilité temporaire de notre API.
- Scalabilité: la charge sur notre serveur ne dépend pas de votre audience. Chaque visite de votre site ne génère aucune requête vers l'API echo.lu.
À éviter
- Appeler l'API depuis du code JavaScript exécuté dans le navigateur.
- Interroger l'API à chaque affichage de page ou à chaque action d'un visiteur.
- Intégrer votre clé API dans le code front-end ou dans une application publique.