Ibijyanye na API yacu

Ijambo ry’ibanze

Iyi paji isobanura uburyo abakora imbuga za interineti bashobora guhuza Sobanukirwa n’izindi mbuga ndetse n’izindi software binyuze muri “API”.

Sobanukirwa ntiragira API yuzuye, ariko tugenda twongeraho ibintu byinshi bishobora gukoreshwa nka API iyo bisabwe.

Gusanisha n’ibibazo bishya

Kugirango ushishikarize abakoresha urubuga rwawe kwihuza n’umuyobozi runaka, koresha URLs ziri ku ifishi /rw/new/minagri. Izi ni ingingo ushobora kongera kuri izo URLs, haba kuri URL cyangwa ubikuye mu ifishi.

• Umutwe - incamake y’ikibazo gishya.
• Ibarwa - umwandiko w’ibarwa. Gusuhuza (Nyakubahwa….) no gusezera (Murakoze) biba biri kumwe n’ibi.
• Igihimba - mu gusimbura ibarwa, iyi yo igaragaza ikibazo cyose uko cyanditswe ku buryo ushobora gusuhuza no gusezera ukoresheje amagambo yawe.
• Utumenyetso - urutonde rw’utumenyetso dutandukanyijwe n’umwanya, ku buryo ushobora kubona no kwisanisha ku bibazo byabajijwe nyuma, urugero: openlylocal spending_id:12345. Utu: tugaragaza ko ari utumenyetso tw’imashini. Utumenyetso tw’imashini dushobora no kuba turimo utwitso, twifashishwa muri URIs.

Urwungano (arirwo Atom) RSS

Hari urwungano Atom kuri paji nyinshi zishyiraho ibibazo by’ubwisanzure bwo kumenya amakuru, ushobora gukoresha ushaka amavugurura n’amahuriro , muri XML. Shaka URL y’urwungano Atom ukoresheje bumwe muri ubu buryo:

• Shaka ihuriro ry’urwungano RSS.
• Genzura <link rel="alternate" type="application/atom+xml"> ku mutwe wa HTML.
• Ongera /feed ku ntangiriro y’indi URL.

By’umwihariko, n’amashakiro agoye afite urwungano Atom. Ushobora gukora ibintu byose uzikoresheje, nko gushaka ukurikije abayobozi, ubwoko bw’inyandiko, amatariki, cyangwa irangamimerere. Ku bindi bisobanuro reba Uburyo bwo gushaka byimbitse.

Dosiye itunganyije ya JSON

Amapaji menshi agira inyandiko za JSON, zigufasha kubika amakuru y’ibintu ari ku murongo. Zishake ukoresheje:

• Kwongera .json ku musozo wa URL.
• Shaka akamenyetso ka <link rel="alternate" type="application/json"> mu mutwe wa HTML.

Ibibazo, abakoresha urubuga n’abayobozi bose bagira inyandiko za JSON zirimo amakuru y’ingenzi aberekeyeho. Buri rwungano Atom rugira JSON bihuye irimo amakuru ku rutonde rw’ibintu byakorewe muri urwo rwungano.

Urutonde rw’abayobozi bose

Urutonde ruriho abantu bose bakoresha Sobanukirwa ruboneka: all-authorities.csv

Andika API

Andika API yashyizweho kugirango ikoreshwe n’abayobozi mu gutanga ibibazo byabo. API ikoreshwa na software ya FOI Register software ya mySociety mu gukoresha Alaveteli kugirango igaragaze ibyanditswe mu bikorwa by’ubwisanzure bwo kumenya amakuru byandikiwe umuyobozi runaka. Ibindi bisobanuro bya tekinike bijyanye na Andika API wabisanga kuri Alaveteli wiki.

Ushobora kutwandikira niba wifuza ikindi kimenyetso cya API kitari aha. Turacyari kwaguka, kandi tugenda twongeraho ibindi bintu iyo babidusabye.