Bienvenue dans la documentation MSANP DHIS-2 API¶
Présentation générale¶
L’API Web est un composant qui permet aux systèmes externes d’accéder et de manipuler les données stockées dans une instance de DHIS2. Plus précisément, il fournit une interface programmatique à un large éventail de données exposées et de méthodes de service pour des applications telles que des clients logiciels tiers, des portails Web et des modules DHIS2 internes.
L’API Web adhère à des nombreux principes qui sous-tendent le style architectural REST. Pour en citer quelques-uns et importants :
Les éléments de base se nomment ressources.Une ressource peut être tout ce qui est exposé sur le Web, d’un document à un processus opérationnel - tout ce qu’un client peut souhaiter interagir avec. Les aspects informationnels d’une ressource peuvent être récupérés ou échangés par le biais de représentations de ressources. Une représentation est une vision du statut d’une ressource à un moment donné. Par exemple, la ressource reportTable dans DHIS2 représente un rapport tabulaire de données agrégées pour un certain ensemble de paramètres. Cette ressource peut être récupérée dans une variété de formats de représentation, y compris HTML, PDF et MS Excel.
Toutes les ressources peuvent être identifiées de manière unique par une URI (aussi appelée URL). Toutes les ressources ont une représentation par défaut. Vous pouvez indiquer que vous êtes intéressé par une représentation spécifique en fournissant un en-tête Accept HTTP, une extension de fichier ou un paramètre de requête de format. Afin de récupérer la représentation PDF d’un tableau de rapport, vous pouvez fournir un en-tête Accept: application/pdf ou annexer .pdf ou ?Format=pdf à l’URL de votre demande.
Les interactions avec l’API nécessitent l’utilisation correcte de méthodes HTTP ou de verbes. Cela implique que pour une ressource, vous devez émettre une requête GET lorsque vous voulez la récupérer, POST request lorsque vous voulez en créer une, PUT lorsque vous voulez la mettre à jour et DELETE lorsque vous voulez la supprimer. Donc si vous voulez récupérer la représentation par défaut d’une table de rapport, vous pouvez envoyer une requête GET à e.g. /reportTable/iu8j/hYgF6t, où la dernière partie est l’identificateur de table de rapport.
Les représentations de ressources sont liées , ce qui signifie que les représentations annoncent d’autres ressources qui sont pertinentes pour l’actuelle en incorporant des liens dans elle-même (veuillez noter que vous devez demander href dans votre filtre de champ pour que cela fonctionne. Cette fonctionnalité améliore considérablement la convivialité et la robustesse de l’API comme nous le verrons plus tard. Par exemple, vous pouvez facilement accéder aux indicateurs associés à un tableau de rapport à partir de la ressource reportTable via les liens intégrés en utilisant votre format de représentation préféré.
Bien que tout cela puisse sembler compliqué, l”API Web est en fait très simple à utiliser. Nous allons procéder avec quelques exemples pratiques.
Important
Le code « xxxxxxxxxxx » dans le bloc de code représente les identifiants, noms, codes ou noms d’utilisateurs dont la donnee sont confidentielles ou ne peut etre autorisés à publier dans cette documentation DHIS2 Madagascar Web API.
Nous pouvions specifier le code « xxxxxxxxxxx » sur l’URL tester dans l’application lorsque vous avez un accès à utiliser le DHIS2.
Nous avons utilisé Postman qui est une application permettant de tester l’API web DHIS2 afin de connaitre davantage à ses fonctionnements et ses ressources.
