About our API

Introduction

Cette page explique la façon dont les programmeurs peuvent faire en sorte que d’autres sites web ou des logiciels interagissent avec Sobanukirwa via une "API".

Sobanukirwa n’a pas encore une API complète, mais nous ajoutons graduellement des outils qui sont similaires à une API.

Lier les nouvelles requêtes

Pour encourager vos utilisateurs à mettre des liens vers un organisme public en particulier, nous proposons des URL avec une forme prédéfinie. /fr/new/minagri. Voici les paramètres que vous pouvez ajouter à ces URL, que ce soit dans l’URL ou d’un formulaire.

• title - résumé par défaut de la nouvelle requête.
• default_letter - le texte par défaut du corps de votre lettre. La salutation (Cher...) et la signature (Sincèrement…) en sont les limites
• body - en tant qu’alternative à default_letter, cette option choisit le texte par défaut pour la demande, afin que vous puissiez personnaliser la salutation et la signature.
• tags - une liste de tags séparés d’une espace, afin que vous puissiez trouver ou lier des requêtes, par exemple openlylocal spending_id:12345. Le deux-points indique qu’il s’agit d’un « machine tag »

Flux RSS (Atom pour être précis)

Il y a des flux Atom sur la plupart des pages qui listent des demandes d’accès à l’information. Vous pouvez les utiliser pour avoir des mises à jour et des liens en format XML. Il y a plusieurs façons de trouver l’URL du flux Atom.

• Rechercher pour les liens.
• Examiner le tag <link rel="alternate" type="application/atom+xml"> en tête du HTML.
• Ajouter/feedau début d’un autre URL.

Même les recherches compliquées ont des flux Atom. Vous pouvez les utiliser de plusieurs façons différentes, comme une recherche par type de fichier, par date ou par statut. Voir pour des recherches avanceés et details.

Données JSON

Plusieurs pages ont des versions JSON qui vous permettent de télécharger de l’information au sujet d’objets dans un formulaire. Vous pouvez les trouver en:

• Ajoutant.json à la fin de l’URL.
• Recherchant le tag <link rel="alternate" type="application/json"> au début du HTML.

Les demandes, les utilisateurs et les autorités ont toutes des versions JSON qui contiennent l’information de base à leur sujet. Chaque flux Atom a un équivalent JSON qui contient l’information au sujet de la liste des événements du flux.

Tableau de tous les organismes

Un fichier de type tableur fait la liste de tous les organismes accessibles à travers Sobanukirwa: all-authorities.csv

5. Write API

L'API d'écriture est conçu pour être utilisé par les autorités pour créer leurs propres demandes dans le système . L'API est actuellement utilisé par mySociety enregistrer logiciels FOI pour soutenir l'usage d'Alaveteli comme un journal d'information pour toutes les activités FOI à un organisme public particulier. Plus d'informations techniques sur l'API d'écriture est disponible sur le wiki Alaveteli.

Merci de nous contacter contact us si vous avez besoin d’une option API qui n’est pas encore disponible. Nous sommes encore en train de perfectionner l’outil, et il nous fait plaisir d’ajouter ce que l’on nous demande. .