Pratiques exemplaires: Utilisation des API

Les données sont présentées sous divers formats. Vous trouverez dans le présent document de l'information, des conseils et des suggestions sur la façon d'utiliser certains des formats présentés dans le Portail de données ouvertes ainsi que la façon de travailler avec des interfaces de programmation d'applications (API).

Sur cette page

Mise en antémémoire des données

La mise en antémémoire est un sujet vaste et peut s'appliquer aux couches mémoire, stoc9kage ou communication des deux côtés d'un client/serveur. Dans ce contexte, le côté serveur désigne la source de données, et le côté client, le développeur ou l'utilisateur qui tente de télécharger les données.

Mise en antémémoire des sources de données

Certaines sources de données peuvent utiliser la mise en antémémoire pour favoriser l'extensibilité. Comme mentionné précédemment, la mise en antémémoire peut être effectuée à différents niveaux du service. Bien que cette opération soit transparente pour les utilisateurs finaux, il est important de comprendre ces pratiques pour interagir efficacement et en toute conformité avec la source de données.

Si les réponses à vos demandes de renseignements font toujours référence aux mêmes jeux de données alors que vous vous attendez à obtenir des références à de nouveaux jeux ou des jeux mis à jour, assurez-vous de ce qui suit :

  • Vous avez vérifié que votre environnement ou vos outils ne produisent aucune mise en antémémoire.
  • Vous êtes en droit de vous attendre à ce que la source de données produise une réponse différente à vos demandes.
  • Vous avez vérifié dans la documentation de la source de données s'il y avait de l'information sur l'horodatage ou sur les règles de mise en antémémoire des réponses.
  • Vous avez tenté de modifier votre demande pour vérifier si la réponse demeurait la même.
  • Vous avez attendu quelques minutes avant de représenter votre demande pour vérifier si les données étaient actualisées après un certain délai.

Dans certains cas, la source de données peut utiliser un réseau de publication de contenu (Content Delivery Network – CDN) pour mettre en antémémoire les réponses fréquentes. Vérifiez les en-têtes HTTP pour déceler toute indication de la présence d'un tel réseau ou de l'utilisation de tout autre mécanisme de mise en antémémoire.

Mise en antémémoire côté client (application)

Vous pouvez identifier dans votre application des possibilités d'optimisation qui permettent la mise en antémémoire partielle ou totale des données. La mise en antémémoire peut accroître considérablement le rendement de votre application et améliorer de manière significative les expériences des utilisateurs. Évidemment, la mise en antémémoire du côté client exige un certain équilibre entre le rendement de l'application et l'exactitude des réponses puisque cette pratique peut rapidement devenir désuète.

Traitement des erreurs

Pour les jeux de données et les API, il est généralement important de reconnaître les codes de réponse HTTP et de réagir de manière appropriée. Voici un sommaire de certains codes de réponse HTTP (anglais seulement) que vous pouvez constater :

Codes de réponse HTTP
Code Sommaire Explication
200 OK Interrogation réussie.
301 Moved Permanently L'élément demandé se trouve maintenant dans le nouvel emplacement suivant.
304 Not Modified L'élément demandé n'a pas été modifié depuis votre dernière demande.
404 Not Found Aucune information trouvée à l'URL demandée.
40x Client Errors Différentes erreurs liées à votre demande.
50x Server Errors Différentes erreurs liées au côté serveur. Il est préférable d'examiner votre demande et de la présenter de nouveau ultérieurement.
Date de modification :