Dolgomvan.hu API dokumentáció

Utolsó módosítás: 2007 október 11.

Az api jelenleg 0.2 alfa állapotban van. Ez egyrészt azt jelenti, hogy bármikor kerülhetnek újdonságok a funkcionalitásba, ugyanakkor bármikor meg is változhatnak bizonyos dolgok, természetesen ez utóbbit igyekszünk elkerülni, a változásokról pedig a blogon beszámolunk.

Jelenleg csak lekérni lehet adatokat az adatbázisból, bevinni nem. Hamarosan ez is megváltozik, oldalak, teendők, jegyzetek, linkek hozzáadhatóak lesznek és a munkaórákat is ki lehet tölteni majd.

API alapok

Ahhoz, hogy a szolgáltatásunkra épülő alkalmazást fejlessz, egy fejlesztői api key-t kell kérned. A fejelsztői kulcs, csak az engine-hez biztosít hozzáférést, a felhasználók adatait csak az egyes felhasználók saját api kulcsuk segítségével kérheted le. A felhasználók a saját kulcsukat a dolgomvan.hu fiókjukban generálhatják és törölhetik.

Mindkét kulcsot hozzá kell fűzni az url-hez api hívásakor.

Válaszként utf-8 kódolású xml-t kapsz vissza, amelyet bármely programozási nyelvben könnyedén feldolgozhatsz.

Oldalak

Egy felhasználó létrehozott oldalainak listáját a következőképpen kérhetjük le:

http://dolgomvan.hu/api/pages/?user_key=xyz&app_key=xyz

A visszakapott xml:

	<apiresponse>
		<page>
			<id>5</id>
			<title>Konferencia</title>
			<description>A konferencia programja és fontos eseményei.</description>
		</page>
		<page>
			<id>8</id>
			<title>Pixel, napi dolgok</title>
			<description>Mindennapi tennivalók.</description>
		</page>
	</apiresponse>

Adott oldal és az összes hozzátartozó adat: jegyzetek, listák és linkek:

http://dolgomvan.hu/api/page/:page_id/?user_key=xyz&app_key=xyz

Munkaórák

Adott oldalhoz tartozó munkaórák listája:

http://dolgomvan.hu/api/timings/:page_id/?user_key=xyz&app_key=xyz

A visszakapott xml:

	<apiresponse>
		<timing>
			<id>5</id>
			<page_id>1</page_id>
			<date>2007-07-28</date>
			<hours>1.0</hours>
			<description>Hétindító meeting..</description>
		</timing>
	</apiresponse>

Jegyzetek

Adott oldalhoz tartozó jegzet:

http://dolgomvan.hu/api/note/:note_id/?page_id=x&user_key=xyz&app_key=xyz

A visszakapott xml:

	<apiresponse>
		<note>
			<id>5</id>
			<page_id>1</page_id>
			<title>Meeting jegyzetek</title>
			<content>Hétindító meeting.</content>
		</note>
	</apiresponse>

Teendők

Adott oldalhoz tartozó, összes teendő-lista:

http://dolgomvan.hu/api/list/:list_id/?page_id=x&user_key=xyz&app_key=xyz

A visszakapott xml:

	<apiresponse>
		<list>
			<id>4</id>
			<page_id>1</page_id>
			<title>Meeting jegyzetek</title>
			
				<todo>
					<id>5</id>
					<list_id>4</list_id>
					<title>Napi teendők</title>
					<is_complete>1</is_complete>
					<due_at>2007-03-05 00:00:00</due_at>
					<completed_at>2007-03-04 19:31:23</completed_at>
				</todo>
			
		</list>
	</apiresponse>

Adott oldalhoz tartozó, adott teendő-lista:

http://dolgomvan.hu/api/lists/?page_id=x&user_key=xyz&app_key=xyz

A visszakapott xml:

	<apiresponse>
		<list>
			<id>4</id>
			<page_id>1</page_id>
			<title>Meeting jegyzetek</title>
			
				<todo>
					<id>5</id>
					<list_id>4</list_id>
					<title>Napi teendők</title>
					<is_complete>1</is_complete>
					<due_at>2007-03-05 00:00:00</due_at>
					<completed_at>2007-03-04 19:31:23</completed_at>
				</todo>
			
		</list>
	</apiresponse>

Linkek

Egy oldalhoz tartozó link lekérdezése, id alapján:

http://dolgomvan.hu/api/link/:link_id/?page_id=x&user_key=xyz&app_key=xyz