A propos de notre API

Introduction

Cette page explique comment les programmeurs peuvent faire en sorte que d'autres sites Web et logiciels interagissent avec Tunabakonzi via une "API".

Tunabakonzi ne dispose pas encore d'une API complète, mais nous ajoutons progressivement de nombreux éléments dont l'utilisation est similaire à celle d'une API, tels qu'ils sont demandés.

Liaison à de nouvelles demandes

Notre fonctionnalité dans le Site est uniquement Pour encourager vos utilisateurs à créer des liens vers une autorité publique particulière, utilisez des liens de la forme /new/liverpool_city_council. Ce sont les paramètres que vous pouvez ajouter à ces URL, soit dans l'URL, soit à partir d'un formulaire.

• title - résumé par défaut de la nouvelle demande.
• default_letter - texte par défaut du corps de la lettre. La salutation (Cher ...) et la signature (Vôtre ...) sont enroulées autour de cela.
• body - au lieu de default_letter, le texte entier par défaut de la demande est défini pour vous permettre de personnaliser la salutation et la signature.
• tags - liste de tags, séparés par des espaces, pour que vous puissiez rechercher et relier toutes les demandes faites ultérieurement, par exemple. openlylocal depenser_id: 12345. Le: indique qu'il s'agit d'une machine tag. Les valeurs des balises machine peuvent également inclure des deux-points, utiles pour les URI.

Flux RSS (actualité, Atom)

Sur la plupart des pages, des flux Atom répertorient les demandes d'accès à l'information que vous pouvez utiliser pour obtenir les mises à jour et les liens au format XML. Recherchez l'URL du flux Atom de l'une des manières suivantes:

• Recherchez les liens de flux RSS.
• Examinez la balise <link rel="alternate" type="application/atom+xml"> dans l'en-tête du code HTML.
• Ajouter /feed au début d'une autre URL.

En particulier, même les requêtes de recherche compliquées ont des flux Atom. Vous pouvez faire toutes sortes de choses avec eux, telles que la requête par autorité, par type de fichier, par plage de dates ou par statut. Voir les astuces de recherche avancée pour plus de détails.

Données structurées JSON

De nombreuses pages ont des versions JSON, qui vous permettent de télécharger des informations sur les objets dans un formulaire structuré. Trouvez-les par:

• Ajout de .json à la fin de l'URL.
• Recherchez la balise <link rel="alternate" type="application/json"> dans l'en-tête du code HTML.

Les demandes, les utilisateurs et les autorités ont tous des versions JSON contenant des informations de base à leur sujet. Chaque flux Atom a un équivalent JSON, contenant des informations sur la liste des événements dans le flux.

Tableur de toutes les autorités

AUn fichier tableur répertoriant tous les utilisateurs de Tunabakonzi est disponible: all-authorities.csv

5. 5. Écrire une api

L'API d'écriture est conçue pour être utilisée par les autorités pour créer leurs propres demandes dans le système. Le logiciel FOI Register de mySociety utilise actuellement l'API pour prendre en charge l'utilisation d'Alaveteli en tant que journal de divulgation pour toutes les activités FOI dans un organisme public donné. Plus d'informations techniques sur l'API d'écriture sont disponibles sur le wiki d'Alaveteli.

Veuillez nous contacter si vous avez besoin d'une fonctionnalité d'API qui n'existe pas encore. C'est vraiment un travail en cours, et nous ajoutons des choses lorsque les gens nous le demandent.