Portail API

Portail API

Date de publication : 11 janvier 2022

Le portail API héberge les API publiques de l’IITA. C’est le point central à partir duquel les utilisateurs et les outils peuvent accéder informatiquement aux services de données de l’IITA.

Les API du portail de l’IITA

Deux API publiques sont actuellement disponibles sur le portail API :

• Outil de validation de l’IITA
• Banque de données de l’IITA

Les utilisateurs de ces API doivent créer un compte et obtenir une clé API gratuite avant de pouvoir les utiliser. Cette étape permet au Secrétariat de l’IITA de mieux suivre l’utilisation des API et d’assurer un service fiable et sécurisé à tous les utilisateurs.

Autres API de l’IITA

Le portail API de l’IITA hébergera à terme toutes les API publiques mises à disposition par l’Initiative. Toutefois, certaines API restent accessibles ailleurs le temps d’effectuer cette migration :

• L’API du registre de l’IITA, qui stocke des informations sur toutes les organisations qui publient des données conformément à la norme de l’IITA.
• L’API des listes de codes, qui propose deux méthodes informatiques pour obtenir les listes de codes nécessaires à la création et à l’interprétation des données de l’IITA.

Comment obtenir des clés API sur le portail de l’IITA

• Consultez la page suivante : https://developer.iatistandard.org
• Cliquez sur « Sign Up » (Créer un compte)
• Suivez la procédure et confirmez la création de votre compte grâce à un lien envoyé par e-mail
• Connectez-vous au portail API destiné aux développeurs (même URL que précédemment)
• Cliquez sur « Subscriptions » (Inscriptions) > « Exploratory » (Exploration) - lien
  • Saisissez le nom d’utilisateur de votre choix dans le champ prévu à cet effet
  • Cochez la case pour accepter les conditions d’utilisation
  • Cliquez sur le bouton « Subscribe » (S’inscrire)
• Cela vous donnera accès à une clé API valable pour 5 appels/minute, et jusqu’à 100 appels/semaine, sans procédure d’approbation.
• Pour bénéficier d’un taux/quota plus important, vous devrez vous inscrire en accès illimité :
• Cliquez sur « Subscriptions » (Inscriptions) > « Full Access » (Accès illimité) - lien
  • Saisissez le nom d’utilisateur de votre choix dans le champ prévu à cet effet
  • Cochez la case pour accepter les conditions d’utilisation
  • Cliquez sur le bouton « Subscribe » (S’inscrire)

Cette option permet aux utilisateurs d’obtenir un accès illimité aux API publiques de l’IITA, même pour un très grand nombre d’appels.

Votre demande sera mise en attente pour être approuvée par le Secrétariat de l’IITA.

• Une fois l’approbation obtenue, vous pourrez utiliser les clés API mises à votre disposition, soit en ligne à partir du portail API, soit en local à partir de vos outils de développement.

Comment tester l’API de l’outil de validation

Test en ligne à partir du portail API

• Accédez aux API > « IATI Validator V2 » (Outil de validation V2) > « POST validate » (Validation POST) - lien
• Cliquez sur le bouton vert « Try it » (Essayer)
• Une fois votre inscription prise en compte, le champ « Subscription Key » (Clé d’inscription) se remplit automatiquement
• Complétez la zone de texte
  • Vous pouvez, au choix, coller une chaîne de caractères brute au format XML ou télécharger un fichier de votre ordinateur en activant l’option « Binary » (Binaire)
• Cliquez sur Send (Envoyer)

Test à l’aide d’outils locaux

• Choisissez un point d’extrémité, p. ex., POST https://api.iatistandard.org/validator/validate
• Clé d’inscription :
  • Copiez votre clé primaire ou secondaire à partir de votre profil en ligne sur le portail API
• Ajoutez un en-tête à votre requête
  • Clé : Ocp-Apim-Subscription-Key
  • Valeur : <votre clé>
• Vous pouvez consulter des exemples de requêtes dans différents langages (HTTP, curl, etc.) en sélectionnant l’option « Try it » (Essayer) de l’API

Comment tester l’API de la banque de données

Test en ligne à partir du portail API

• Accédez aux API > « IATI Datastore » (Banque de données de l’IITA) > « GET Query » (Requête GET) - lien
• Cliquez sur le bouton vert « Try it » (Essayer)
• Une fois votre inscription prise en compte, le champ « Subscription Key » (Clé d’inscription) se remplit automatiquement
• Renseignez les paramètres requis :
  • « collection » : quel type de données vous souhaitez interroger
    • « activity » (activité)
    • « budget » (budget)
    • « transaction » (transaction)
  • « responsetype » : le type de réponses souhaité
    • « select » (sélectionner) : sélectionnez le format de votre choix (JSON [flat], CSV ou SOLR XML)
    • « iati » (IITA) : vous recevrez les données au format XML utilisé par l’IITA (uniquement disponible si vous avez choisi d’interroger les activités)
    • « iati_json » : vous recevrez les données au format JSON structuré (uniquement disponible si vous avez choisi d’interroger les activités)
  • « q » : pour définir une requête en utilisant la syntaxe standard. Ce paramètre est obligatoire. P. ex., pour rechercher les descriptions des ONG : description_narrative:NGO
• Cliquez sur Send (Envoyer)

Test à l’aide d’outils locaux

• Choisissez un point d’extrémité, p. ex., GET https://api.iatistandard.org/datastore/activity/select?q=description_narrative:NGO
• Clé d’inscription :
  • Copiez votre clé primaire ou secondaire à partir de votre profil en ligne sur le portail API
• Ajoutez un en-tête à votre requête
  • Clé : Ocp-Apim-Subscription-Key
  • Valeur : <votre clé>
• Vous pouvez consulter des exemples de requêtes dans différents langages (HTTP, curl, etc.) en sélectionnant l’option « Try it » (Essayer) du portail destiné aux développeurs