O našem API

Uvod

Ova stranica objašnjava na koji način programeri mogu učiniti da druge web stranice i softveri imaju interakciju sa BIRN-ov FOI Tracker via "API"

BIRN-ov FOI Tracker još uvijek nema potpuni API, ali postepeno dodajemo puno stvari koje su slične u korištenju API-ju kako se traži.

Povezivanje sa novim zahtjevima

Kako bi ohrabrili korisnike da povežu zahtjeve sa određenim javnim ustanovama, koristi se sljedeći URL form /new/liverpool_city_council. Ovo su parametri koji su mogu dodati u URL, ili kao URL ili kao formular.

• naslov - podrazumijevani sažetak novog zahtjeva.
• default_letter - default tekst zahtjeva. Pozdrav (Poštovani...) i potpis (Srdačno..) su u sklopu ovoga.
• body - kao alternativa deffault_letter, ovo prikazuje cijeli tekst zahtjeva, kako bi prilagodili pozdrav i potpis.
• tags - prostor između tag-ova, kako bi mogli pronaći i povezati zahtjeve koji su poslani poslije, e.g. openlylocal spending_id:12345. Znak dvotačke : pokazuje da je mehanički tag. Vrijednosti oznake mogu uključivati dvotačke unutar URL.

RSS

Na većini stranica postoji Atom feed, koji se koristi da bi dobili novosti i linkove u XML formatu. Pronađite URL od nekih Atom feed na sljedeći način:

• Potražite RSS linkove.
• Ispitajte oznaku <link rel="alternate" type="application/atom+xml"> u zaglavlju HTML-a.
• Dodajte /feed na početak drugog URL-a.

Konkretno, čak i komplikovani upiti za pretraživanje imaju Atom feedove. S njima možete raditi sve vrste stvari, kao što je upit prema ovlaštenju, tipu datoteke, rasponu datuma ili statusu. Pogledajte savjete za naprednu pretragu za detalje.

JSON stuktuirani podaci

Dosta stranica ima JSON verzije, koje vam omogućavaju preuzimanje informacija o objektima u strukturiranom obliku. Pronađite ih po:

• Dodavanje .json na kraj URL-a.
• Potražite oznaku <link rel="alternate" type="application/json"> u zaglavlju HTML-a.

Svi zahtjevi, korisnici i ovlaštenja imaju JSON verzije koje sadrže osnovne informacije o njima. Svaki Atom feed ima JSON ekvivalent, koji sadrži informacije o listi događaja u feedu.

Tabela svih organa

Dostupna je tabela sa spiskom svih tijela u BIRN-ov FOI Tracker: all-authorities.csv

5. Write API

API za pisanje je dizajniran da ga koriste vlasti za kreiranje vlastitih zahtjeva u sistemu. API trenutno koristi softver mySociety FOI registar kako bi podržao korištenje Alaveteli kao dnevnika otkrivanja svih aktivnosti FOI u određenom javnoj insitituciji. Više tehničkih informacija o API za pisanje dostupno je na Alaveteli wiki.

Molimo kontaktirajte nas ako vam je potrebna API funkcija koja još nije tu. S obzirom da je ovaj projekt work in progress, mi dodajemo stvari kada ljudi to od nas traže.