Az API

Bevezetés

Ezen az oldalon elolvashatja, hogyan hozhatók létre további, külsõ weboldalak az adatigénylésekbõl és hogy hogyan hivatkozhat a KiMitTud rendszerben szereplõ adatokra.

A KiMitTud nem rendelkezik még teljes API-val, de az igényeknek megfelelõen folyamatosan fejlesztünk olyan dolgokat, amelyek használata hasonlít az API-hoz.

Új igénylésekre mutató hivatkozás elhelyezése

Ha az adatigénylésekre mutató hivatkozásokat szeretne elhelyezni, az URL-ek formája a következõ legyen: http://kimittud.hu/new/naih. Az alábbi paramétereket adhatja hozzá az URL-ekhez akár magában az URL-ben, akár ûrlapról.

• title - új adatigénylés alapértelmezett összefoglalása.
• default_letter - levél törzsének alapértelmezett szövege. Az üdvözlés (Tisztelt...) és az elbúcsúzás (üdvözlettel...) ezt ölelik körbe.
• body - a default_letter alternatívájaként ez meghatározza az adatigénylés teljes szövegének alapértékét, és így az üdvözlés és elbúcsúzás személyre szabható lehet.
• tags - címkék szóközzel elválasztott listája, amely alapján az adatigénylések bármikor kikereshetõk és hivatkozhatók, pl. openlylocal spending_id:12345. A : gépi címkét jelöl. A gépi címkék értéke tartalmazhat kettõspontot, amely URL-ek esetében hasznos lehet.

RSS- (Atom) hírfolyam

A legtöbb olyan oldalon, amelyen közérdekû adatigénylések listája szerepel, Atom hírfolyam is található, amelynek segítségével frissítésekhez és XML formátumú hivatkozásokhoz juthat hozzá. Az Atom hírfolyam URL-jét az alábbi módokon keresheti meg:

• Keresse az RSS-hírfolyam hivatkozást.
• Vizsgálja meg a <link rel="alternate" type="application/atom+xml"> címkét a HTML fejrészében.
• Adja a /feed elemet egy másik URL elejéhez.

Még az összetettebb keresési lekérdezésekhez is tartozik Atom hírfolyam. Ezek sok mindenre használhatók: kereshet például közintézmény, fájltípus, dátumtartomány vagy állapot szerint. További részletekért lásd az összetett keresésre vonatkozó tippek címû részt.

JSON formátumú strukturált adatok

Jónéhány oldalnak van JSON verziója is, amelynek segítségével az objektumokról strukturált formában tud letölteni információt. Ezeket így lehet megtalálni:

• Adja a .json elemet az URL végéhez.
• Keresse meg a <link rel="alternate" type="application/json"> címkét a HTML fejrészében.

Az igénylések, a felhasználók és a közintézmények mind rendelkeznek JSON verzióval, amely tartalmazza a rájuk vonatkozó legfontosabb adatokat. Minden Atom hírfolyamnak van JSON formátumú megfelelõje, amely a hírfolyamban található események listájára vonatkozóan tartalmaz adatokat.

Az összes közintézményt tartalmazó tábla

A KiMitTud weboldalon keresztül elérhetõ összes közintézményt tartalmazó lista: all-authorities.csv

Ha olyan API-funkcióra van szüksége, amelyet nem talál, lépjen velünk kapcsolatba. Folyamatos fejlesztésrõl van szó, és igény esetén újabb és újabb funkciók jelenhetnek meg a rendszerben.