Bienvenue aux Nations Unies
Guide du portail
Barre d’outils d’accessibilité du portail
Augmenter le contraste
Augmenter la taille de la police
Diminuer la taille de la police
Réinitialiser le style de la page

Documentation API

À propos de l’interface API des indicateurs

L’interface API des indicateurs d’ONU-Eau donne accès aux données recueillies par diverses sources. La plupart de ces indicateurs sont disponibles en ligne. L’API fournit un accès programmatique à ces mêmes données. De nombreuses séries de données remontent à plus de 50 ans et peuvent constituer le matériau de travaux d’un grand intérêt.

L’API des indicateurs donne accès aux bases de données de nombreux organismes :

  • OMS
  • PNUD
  • UNICEF
  • FAO
  • etc.

Comment utiliser l’API des indicateurs ?

 Par exemple : https://sdg6data.org/api/indicator/6.1.1?_format=json

Outre les appels de l’API par l’intermédiaire d’une application ou d’un programme personnalisé, vous pouvez placer n’importe lequel des exemples de points d’extrémité URL de l’API donnés dans la documentation ou vos propres appels personnalisés dans un navigateur Internet et consulter les résultats. Si vous choisissez de recevoir le résultat au format JSON, vous pouvez utiliser le module JSON View de Firefox pour voir les résultats directement dans Firefox.

Selon vos objectifs, certaines applications et bibliothèques tierces peuvent également faciliter l’utilisation de l’API. 

Vérifiez la structure d’appel de base indiquée ci-dessous :

La documentation API ci-dessous montre comment accéder à ces données pour les utiliser dans votre application.

https://sdg6data.org/api/indicator/{indicator_code}?_format=xml

Paramètres de la requête :

{indicator_code} – Il peut s’agir du code de n’importe quel indicateur de suivi de l’ODD 6. Le code d’indicateur fait partie de l’URL de l’API et doit obligatoirement être transmis lors de l’appel de l’API.

https://sdg6data.org/api/indicator/6.1.1?_format=xml

L’URL ci-dessus renverra les données pour toutes les années et tous les pays de l’indicateur 6.1.1.

_format : Format de sortie. L’API fonctionne avec deux formats : xml et json. Ce paramètre est obligatoire conformément aux normes RESTful Webservice de Drupal 8.

https://sdg6data.org/api/indicator/6.1.1?_format=xml

https://sdg6data.org/api/indicator/6.1.1?_format=json

par_page : nombre de résultats par page, pour la pagination de l’ensemble de résultats. Réglage par défaut : 50

https://sdg6data.org/api/indicator/6.1.1?_format=xml&per_page=20

page – paramètre facilitant la consultation d’un grand ensemble de résultats. Indique le numéro de page demandé à partir du jeu d’enregistrements.

https://sdg6data.org/api/indicator/6.1.1?_format=xml&page=2

date – plage de dates par année, mois ou trimestre qui délimite l’ensemble de résultats. Les intervalles sont indiqués à l’aide des deux points (:)

https://sdg6data.org/api/indicator/6.1.1?_format=xml&date=2000:2001

Afficher toutes les données de l’indicateur en utilisant la requête de l’indicateur avec des paramètres de pays multiples

https://sdg6data.org/api/indicator/6.1.1?_format=json&country=CAN,ALB

Afficher toutes les données de l’indicateur en utilisant la requête de l’indicateur

https://sdg6data.org/api/indicator/all?_format=json

Requêtes de l’API pour les indicateurs

Les indicateurs représentent des données telles que les zones nationales, urbaines et rurales, la disponibilité et l’utilisation de l’eau, la gestion des ressources en eau, le nombre de décès, le nombre de disparus, etc. Les requêtes d’indicateurs génèrent des réponses contenant les informations suivantes :

  • Goal (Objectif)
  • Target (Cible)
  • Indicator (Indicateur)
  • SeriesCode (Code de la série)
  • SeriesDescription (Description de la série)
  • GeoAreaType (Type de zone géographique)
  • GeoAreaName (Nom de la zone géographique)
  • GeoAreaCode (Code de la zone géographique)
  • TimePeriod (Période)
  • Value (Valeur)
  • Time_Detail (Détail temporel)
  • Source (Source)
  • FootNote (Note de bas de page)
  • Nature (Nature)
  • Units (Unités)
  • Age (Âge)
  • Bounds (Limites)
  • Frequency (Fréquence)
  • Frequency (État_Niveau)
  • Location (Emplacement)
  • Reporting_Type (Type de rapport)
  • Sex (Sexe)

Exemple de format de requête : Requête d’indicateur

Pour demander tous les indicateurs : https://sdg6data.org/api/indicator/all?_format=json

Pour demander l’indicateur 6.1.1, utilisez son code indicateur,

6.1.1

Exemple de format de réponse : Requête d’indicateur

 <response> <item key="0"> <page>0</page> <pages>11593</pages> <per_page>50</per_page> <total>579635</total> </item> <item key="1"> <item key="0"> <Goal/> <Target/> <Indicator>6.1.1 </Indicator> <SeriesCode/> <SeriesDescription>Eau de boisson, Service de base au moins</SeriesDescription> <GeoAreaType>Pays</GeoAreaType> <GeoAreaName>ABW</GeoAreaName> <GeoAreaCode>533</GeoAreaCode> <TimePeriod>2000</TimePeriod> <Value>94,488806355508</Value> <Time_Detail/> <Source>OMS, UNICEF</Source> <FootNote/> <Nature/> <Units/> <Age/> <Bounds/> <Frequency/> <Level_Status/> <Location>National</Location> <Reporting_Type/> <Sex/> <SDG_6_Data_Portal_level><![CDATA]6.1.1 Proportion de la population utilisant un service d’eau de boisson géré en toute sécurité (en %) > Service de base au moins > National
 [{   "page":0, "pages":11593, "per_page":50, "total":579635   }, [{ "Goal":null,   "Target":null,   "Indicator":"6.1.1",   "SeriesCode":null,   "SeriesDescription":"Eau de boisson, Service de base au moins",   "GeoAreaType":"Pays",   "GeoAreaName":"ABW",   "GeoAreaCode":"533",   "TimePeriod":"2000",   "Value":"94,488806355508",   "Time_Detail":null,   "Source":"OMS, UNICEF",   "FootNote":null,   "Nature":null,   "Units":null,   "Age":null,   "Bounds":null,   "Frequency":null,   "Level_Status":null,   "Location":"National",   "Reporting_Type":null,   "Sex":null,   "SDG_6_Data_Portal_level":"6.1.1 Proportion de la population utilisant un service d’eau de boisson géré en toute sécurité (en %) \u003E Service de base au moins \u003E National"   }]  ]

Exemple de format de réponse : Requête d’indicateur avec filtre de pays :

 [{"page":0, "pages":2804, "per_page":50, "total":140199}, [{"Objectif":néant, "Target":null, "Indicator":"6.1.1", "SeriesCode":null, "SeriesDescription":"Eau de boisson, Service de base au moins", "GeoAreaType":"Pays", "GeoAreaName":"ABW", "GeoAreaCode":"533", "TimePeriod":"2000", "Value":"94,488806355508", "Time_Detail":null, "Source":"OMS,UNICEF", "FootNote":null, "Nature":null, "Units":null, "Age":null, "Bounds":null, "Frequency":null, "Level_Status":null, "Location":"National", "Reporting_Type":null, "Sex":null, "Portail_données_ODD_6_niveau":"6.1.1 Proportion de la population utilisant un service d’eau de boisson géré en toute sécurité (%) \u003E Service de base au moins \u003E National"}]

Vous pouvez télécharger la liste des pays avec les codes ISO3 ici

Accès à l’API / Authentification

Les clés d’API et autres méthodes d’authentification ne sont plus nécessaires pour accéder à l’API.