Logo du gouvernement du Québec

Foire aux questions

1 réponse trouvé

Avez-vous des exemples de requêtes aux API?

Les interactions avec l’API se font par requêtes HTTP via des instructions qui utilisent la méthode GET. Ces instructions doivent être enregistrées dans un fichier au format JSON, autant pour l’envoi de la requête à l’API que pour la réception de sa réponse (ex.: code erreur, liste des jeux de données).

API global

Lister tous les jeux de données (appelés « package » avec l’API):
https://www.donneesquebec.ca/recherche/api/action/package_list

Lister toutes les catégories:
https://www.donneesquebec.ca/recherche/api/action/group_list

Faire une recherche sur le mot clé « pompier »:
https://www.donneesquebec.ca/recherche/api/3/action/package_search?q=pompier

API datastore

Faire une recherche sur les cinq premiers éléments d’un jeu de données des municipalités dans la base de données:
https://www.donneesquebec.ca/recherche/api/action/datastore_search?resource_id=19385b4e-5503-4330-9e59-f998f5918363&limit=5

L’encodage utilisé par défaut par les API est UTF-8. L’utilisation d’autres encodages (ex. : ANSI, ISO-8859-1) peut engendrer des problèmes de compatibilité. Par exemple, les caractères latins « é » et « à » risquent d’être convertis en caractères non conformes (« Ã » et « ? »).

Il faut donc s’assurer :

  1. de spécifier l’encodage UTF-8 dans l’instruction de requête à l’API si les fichiers de données ne sont pas déjà encodés en UTF-8;
  2. que le fichier au format JSON contenant les instructions de requête à l’API soit également encodé en UTF-8, car sinon, les caractères accentués ne seront pas correctement interprétés, puisque convertis en caractères non conformes.