Bonnes pratiques

Authentification et gestion des tokens

• Conservation du token : Stockez le token JWT reçu après authentification de manière sécurisée et réutilisez-le pour toutes vos requêtes.

• Renouvellement préventif : Les tokens ont une durée de validité limitée. Planifiez un renouvellement avant leur expiration pour éviter les interruptions de service.

• Sécurité : Ne transmettez jamais vos identifiants ou tokens dans les URL ou en tant que paramètres de requête. Utilisez toujours l'en-tête Authorization: Bearer <token>.

Optimisation des requêtes

• Utilisation des filtres : Même si vos données sont déjà filtrées par le système de scopes, utilisez les paramètres de filtrage spécifiques pour préciser davantage vos requêtes et réduire le volume de données.

• Pagination efficiente : Utilisez systématiquement la pagination et adaptez la taille des pages (limit) en fonction de vos besoins spécifiques.

• Mise en cache : Mettez en cache les réponses peu susceptibles de changer fréquemment, comme les informations sur les lieux ou les contributeurs.

Gestion des erreurs

• Codes HTTP : Interprétez correctement les codes de statut HTTP pour diagnostiquer les problèmes :

  • 400 : Requête mal formée ou paramètres invalides

  • 401 : Authentification requise ou credentials invalides

  • 403 : Accès non autorisé aux ressources demandées

  • 404 : Ressource non trouvée

  • 429 : Rate limiting (trop de requêtes)

  • 500 : Erreur interne du serveur

• Retry avec backoff : Implémentez une stratégie de retry avec délai exponentiel pour les erreurs temporaires (500, 502, 503, 504).

Respect des limites

• Rate limiting : Respectez les limites de taux de requêtes pour éviter d'être temporairement bloqué.

• Volumétrie : Ne demandez que les données dont vous avez réellement besoin en utilisant les paramètres appropriés.

• Requêtes parallèles : Limitez le nombre de requêtes simultanées vers notre API pour éviter de surcharger le service.

Mise à jour de vos intégrations

• Versioning : Soyez attentif aux annonces concernant les nouvelles versions de l'API et planifiez les mises à jour de vos intégrations.

• Tests réguliers : Validez régulièrement que votre intégration fonctionne comme prévu, même en l'absence de modifications de votre côté.

• Documentation : Consultez périodiquement notre documentation pour prendre connaissance des nouvelles fonctionnalités ou changements.