Applikationsprogrammeringsgränssnitt - vårt API

Introduktion

Den här sidan förklarar hur programmerare kan göra andra webbplatser och mjukvara interagera med plattformen handlingar.se via vårt "API" (Application Programming Interface).

Handlingar.se har inte ett fullständigt API ännu. Vi lägger successivt till fler funktioner som skapar fler möjligheter för användning genom API. Vill du som myndighet, företag eller förening använda Handlingar.se via API? Ta gärna kontakt med oss så berättar vi mer.

1. Länka till nya förfrågningar

För att uppmuntra användare att göra förfrågningar till en särskild myndighet, använder webbadresser formen: https://handlingar.se/new/regeringskansliets_forvaltningsavdelning. Dessa är de parametrar som du kan lägga till dessa webbadresser, antingen i webbadressen eller från ett formulär.

• title - standardsammanfattning av den nya begäran.
• default_letter - standardtexten i kroppen av brevet. Hälsningen (Kära ...) och signaturen (Din ...) lindas runt detta.
• body - som ett alternativ till default_letter ställer detta hela standardtexten begäran, så att du kan skräddarsy hälsningen och signoff.
• tags - blankstegs-separerad lista med taggar, så att du kan hitta och knyta upp alla begäranden som görs senare, t.ex. openlylocal spending_id:12345. Denna ":" indikerar att den är en maskin-tagg. Värdena för maskin-taggar kan också inkludera kolon, användbara för URI:er.

2. RSS-flöden (egentligen Atom-flöden)

Det finns Atom-feeds på de flesta sidor som listar förfrågningar om allmänna handlingar. De kan du använda för att få uppdateringar och länkar i XML-format. Hitta webbadressen till Atom-flödet på något av följande sätt:

• Leta efter RSS-flödets länkar.
• Undersök <link rel="alternate" type="application/atom+xml"> taggen i "head" på HTML.
• Lägg till /feed på början av en annan webbadress som URL.

Även komplicerade sökfrågor har Atom-flöden. Du kan göra alla möjliga saker med dem, till exempel skapa fråga efter myndighet, efter fil-typ, efter datumintervall eller efter status. Se tips för avancerad sökning för mer information.

3. JSON-strukturerade data

En hel del sidor har JSON-versioner som låter dig ladda ner information om objekt i en strukturerad form. Hitta dem genom att:

• Lägga till .json slutet av webbadressen i URL:en.
• Leta efter <link rel="alternate" type="application/json"> taggen i "head" på HTML.

Förfrågningar, användare och myndigheter har alla JSON-versioner som innehåller grundläggande information om dem. Varje Atom-flöde har en JSON-motsvarighet, innehållande information om listan över händelser i flödet.

4. Kalkylblad för alla myndigheter

Ett kalkylblad som listar varje myndighet på Handlingar.se finns tillgänglig här: all-authorities.csv

5. Skriv-API

API:et för att skriva är utformat för att kunna användas av användare eller myndigheter för att skapa sina egna förfrågningar i systemet men kan användas på fler sätt. API:et används idag av t.ex. mySocietys mjukvara för förfrågningar om allmän handling och e-diarium Det kan stödja användning av Alaveteli som ett publiceringsverktyg och e-diarium för allmänna handlingar vid en offentlig organisation. Mer teknisk information om skriv-API finns på hemsidan hemsidan Alaveteli.org.

Vänligen kontakta oss eller bidra till projektet Alaveteli om du behöver en API-funktion som inte finns ännu. Det är ett pågående arbete, och vi lägger till saker när folk frågar oss och vi har resurser att implementera tillägg. Vi tar också emot bidrag i form av kod eller pengar för att finansiera vidareutvecklingen.