За нашиот API

Вовед

Оваа страница објаснува како програмерите можат да направат другите веб-локации и софтвери да комуницираат со BIRN-ov FOI Tracker преку „API“. BIRN-ov FOI Tracker сè уште нема целосен API, но постепено додаваме многу работи, кои се слични на API.

BIRN-ov FOI Tracker Сè уште нема целосен API, но постепено додаваме многу работи кои се слични на користењето на API според барањето.

Поврзување со нови барања

За да ги охрабрите вашите корисници да создаваат врски до одредена јавна власт, користете URL-адреси од формата /new/liverpool_city_council /new/liverpool_city_council. Ова се параметрите што можете да ги додадете на тие URL-адреси, или во URL-то или од формуларот.

• наслов - стандардно резиме на новото барање.
• стандардна_буква - стандарден текст на телото на буквата. Поздравот (Драга...) и знакот (Твојот...) се обвиткани околу ова.
• тело - како алтернатива на default_letter, ова го поставува стандардниот целосен текст на барањето, за да можете да го приспособите поздравот и отпишувањето.
• ознаки - список на ознаки одвоен простор, за да можете да ги најдете и да ги поврзете сите барања направени подоцна, на пр. openlylocal shpenziming_id:12345. : означува дека е машинска ознака. Вредностите на машинските ознаки може да вклучуваат и две точки, корисни за URL-адреси.

RSS

Повеќето страници, на кои се наведени барањата за СПИ, содржат Atom feed, кој се користи за добивање ажурирани вести и врски во XML формат. Најдете ја URL-адресата на Atom feed на следниов начин:

• Побарајте ја RSS RSS врски.
• Испитајте ја ознаката ; во заглавието на HTML.
• Додадете /feed на почетокот на другата URL адреса.

Особено комплицираните барања за пребарување имаат Atom feed-ови. Со нив можете да правите различни работи, како што се барања според овластувањето, видот на датотеката, опсегот на датумите или статусот. За повеќе детали, видете ги советите за напредно пребарување.

JSON структурирани податоци

Доста страници имаат JSON верзии, кои ви дозволуваат да преземате информации за објекти во структурирана форма. Најдете ги со:

• Adding .json to the end of the URL.
• Look for the <link rel="alternate" type="application/json"> tag in the head of the HTML.

Requests, users and authorities all have JSON versions containing basic information about them. Every Atom feed has a JSON equivalent, containing information about the list of events in the feed.

Табеларен приказ на сите институции

Достапна е датотека со табеларни пресметки што го наведува секое тело во BIRN-ov FOI Tracker: all-authorities.csv

5. Напиши API

Write API е наменето за властите и тие можат да го користат за да креираат свои барања во системот. API моментално се користи од mySociety FOI Register софтверот, за да се поддржи користењето на Алаветели како дневник за откривање на сите активности во врска со СПИ во одредено јавно тело. Повеќе технички информации за Write API се достапни на Alaveteli wiki.