API du registre
Documentation API
L’interface de programmation d’applications (API) du registre de l’IITA est basée sur le protocole HTTP qui permet d’exécuter, du point de vue de la programmation, une requête sur l’ensemble des métadonnées contenues dans le registre, mais aussi de créer et de gérer des ensembles de données, entre autres choses. L’API du registre de l’IITA est une application de l’API de CKAN – voir la documentation complète de l’API de CKAN.
Accès à l’API
Authentication
L’authentification de l’API se fait au moyen de la clé API du registre de l’IITA. Pour obtenir la clé API, il vous suffit de vous rendre dans l’interface utilisateur du registre de l’IITA et de vous connecter à votre compte. Lien URL : https://iatiregistry.org/user/<your username>
Autorisation
Certaines fonctions de l’API sont soumises à autorisation. Lorsque vous exécutez une fonction API soumise à autorisation, vous devez vous identifier en ajoutant l’en-tête d’autorisation suivant à votre requête : ('Authorization', 'Your API Token'). Pour en savoir plus sur l’authentification de l’API, consultez le guide de l’utilisateur de CKAN.
Réponse
Toutes les requêtes de l’API du registre de l’IITA renvoient des données au format JSON.
Liste des points d’extrémité de l’API
La présente section répertorie tous les points d’extrémité de l’API du registre de l’IITA. Cliquez sur chacun des points d’extrémité pour découvrir en détail comment les utiliser.
Points d’extrémité du paquet/de l’ensemble de données
- Accès/Liste de tous les ensembles de données du registre de l’IITA
- Rechercher des ensembles de données de l’IITA et accéder aux métadonnées des ensembles de données
- Accéder aux métadonnées des ensembles de données et à leurs ressources
- Créer un ensemble de données
- Mettre à jour un ensemble de données
- Corriger un ensemble de données
- Supprimer un ensemble de données
Points d’extrémité de la ressource
- Accéder aux métadonnées de la ressource
- Mettre à jour une ressource
- Corriger une ressource
- Supprimer une ressource