Rreth API-së tonë

Hyrje

Kjo faqe shpjegon se si programuesit mund të ndikojnë që faqet e internetit dhe softuerët e tjerë të ndërveprojnë me BIRN FOI Tracker nëpërmjet një "API".

BIRN FOI Tracker nuk ka akoma një API të plotë, por gradualisht jemi duke shtuar shumë gjëra të ngjashme në përdorim me një API, ashtu siç kërkohet.

Lidhja me kërkesat e reja

Për të inkurajuar përdoruesit tuaj që të lidhen me një institucion publik, përdorni URL të formës /new/liverpool_city_council. Këto janë parametrat që mund të i shtoni në ato URL, qoftë në URL ose nga një formular.

• titulli - përmbledhja e paracaktuar e kërkesës së re.
• default_letter - teksti i paracaktuar i trupit të letrës. Përshëndetja (I dashur...) dhe nënshkrimi (i juaji...) janë mbështjellë rreth kësaj.
• body -si një alternativë ndaj default_letter, kjo cakton të gjithë tekstin e paracaktuar të kërkesës, kështu që ju mund të personalizoni përshëndetjen dhe nënshkrimin.
• tags - Lista e etiketave të ndara nga hapësira, kështu që mund të gjeni dhe lidhni çdo kërkesë të bërë më vonë, p.sh. openlylocal shpenzimi_id:12345. : tregon se është një etiketë makine. Vlerat e etiketave të makinës mund të përfshijnë gjithashtu dy pika, të dobishme për URL-të.

RSS

Ka burime Atom në shumicën e faqeve që listojnë kërkesat për FOI, të cilat mund t'i përdorni për të marrë përditësime dhe lidhje në formatin XML. Gjeni URL-në e furnizimit Atom në një nga këto mënyra:

• Kërkoni për RSS lidhjeve.
• Shqyrtoni <link rel="alternate" type="application/atom+xml"> etiketa në kokën e HTML.
• Shto /feed në fillimin e një URL-je tjetër

Në veçanti, edhe pyetjet e ndërlikuara të kërkimit kanë burime Atom. Ju mund të bëni të gjitha llojet e gjërave me to, si p.sh. pyetje sipas autoritetit, sipas llojit të skedarit, sipas intervalit të datave ose sipas statusit. Shikoni këshillat e kërkimit të avancuar për detaje.

Të dhëna të strukturuara JSON

Shumë faqe kanë versione JSON, të cilat ju lejojnë të shkarkoni informacione rreth objekteve në një formë të strukturuar. Gjeni ato sipas:

• Duke shtuar .json në fund të URL-së.
• Kërkoni <link rel="alternate" type="application/json"> në kokën e HTML.

Kërkesat, përdoruesit dhe autoritetet kanë të gjithë versione JSON që përmbajnë informacion bazë rreth tyre. Çdo furnizim Atom ka një ekuivalent JSON, që përmban informacion në lidhje me listën e ngjarjeve në furnizim.

Tabelë e të gjitha autoriteteve

Ka një tabelë që liston çdo institucion në BIRN FOI Tracker: all-authorities.csv

5. Shkruani API

API-ja është krijuar për t'u përdorur nga institucionet që ato të bëjnë kërkesat e tyre në sistem. The API is currently used by mySociety's FOI Regjistro softuerin për të mbështetur përdorimin e Alavetelit si një regjistër zbulimi për të gjithë aktivitetin e FOI në një organ të caktuar publik. Më shumë informacion teknik rreth shkrimit API është në dispozicion në Alaveteli wiki.

Ju lutem na kontaktoni nëse keni nevojë për një API feature që nuk është ende në dispozicion. Projekti është punë në progres dhe ne shtojmë gjëra kur njerëzit na e kërkojnë.