Help > Developers API

Subjects

Developers API

If you are a developer, you can go further with KreuZZ thanks to its API. With it, you can manage your bookmarks very easily.
All API accesses must be made in HTTP GET method with http://www.kreuzz.com/api/ as base url. Results are in XML format..

Login is made using HTTP AUTH mechanism, ie you need to put login and password in your url as follow :

http://login:password@www.kreuzz.com/api/

Here are the different methods you can access :

Tags operations :


http://www.kreuzz.com/api/links/tags/get/

Action :
Return all the tags used in the bookmark library.
Parameters :
- include_private (optionnal) value : 0 or 1
Example : 
URL : http://www.kreuzz.com/api/links/tags/get/
<tags>
	<tag count="2" tag="adminsys"/>
	<tag count="1" tag="array de tags"/>
	<tag count="2" tag="bd"/>
	<tag count="20" tag="blog"/>
	<tag count="2" tag="cocktails"/>
<tags>


Bookmarks operations :


- http://www.kreuzz.com/api/links/bookmarks/get/

Action :
Return all the bookmarks matching the filter(s). If no date parameter is set, the last added bookmark date will be used..
Parameters :
- tag (optionnal) : filter with this tag
- dt (optionnal) : filter with this date, format : YYYY-MM-DD
- url (optionnal) : filter with this url
Example : 
URL : http://www.kreuzz.com/api/links/tags/get/?dt=2006-10-03

<bookmarks>
	<bookmark id="257" href="http://jessysapho.blogspot.com/2006/10/prservons-nos-pots-dchappement.html" 
        title="Préservons nos pots d'échappement" description="" tags="blog,fun" date_added="2006-10-03T01:15:03+02:00" private="0"/>
	<bookmark id="256" href="http://www.eskuel.net/blog/2006/10/02/839-de-la-lecture-en-perspective/" 
        title="De la lecture en perspective" description="" tags="blog,interest" date_added="2006-10-03T01:03:57+02:00" private="0"/>



- http://www.kreuzz.com/api/links/bookmarks/recent/

Action :
Return the latest bookmarks added. Max : 100.
Parameters :
- tag (optionnal) : filter with this tag
- count (optionnal) : number of bookmarks
- include_private (optionnal) value : 0 or 1
Example : 
URL : http://www.kreuzz.com/api/links/bookmarks/recent/?count=2

<bookmarks tag="">
	<bookmark id="188" href="http://www.le-cuisinier.net/" title="Recettes de cuisine" 
        description="" tags="cocktails,cuisine,recettes" date_added="2005-10-21T10:42:12+02:00" private="0"/>
	<bookmark id="195" href="http://www.meyerweb.com/" title="meyerweb.com" 
        description="" tags="blog,CSS" date_added="2005-10-19T11:58:00+01:00" private="0"/>
</bookmarks>



- http://www.kreuzz.com/api/links/bookmarks/dates/

Action :
Return a list of dates with number of bookmarks added at each date.
Parameters :
- tag (optionnal) : filter with this tag
Example : 
URL : http://www.kreuzz.com/api/links/bookmarks/dates/

<dates tag="">
	<date count="3" date="2006-10-31"/>
	<date count="2" date="2006-10-03"/>
</dates>



- http://www.kreuzz.com/api/links/bookmarks/all/

Action :
Return all bookmarks.
Parameters :
- tag (optionnal) : filter with this tag
- include_private (optionnal) : Include private links, value : 0 or 1
Example : 
URL : http://www.kreuzz.com/api/links/bookmarks/all/

<bookmarks>
	<bookmark id="195" href="http://www.meyerweb.com/" title="meyerweb.com" description="" 
        tags="blog,CSS" date_added="2005-01-05T11:58:00+01:00" private="0"/>
	<bookmark id="196" href="http://csszengarden.com/" title="css Zen Garden: The Beauty in CSS Design" description=""
        tags="CSS" date_added="2005-01-05T11:57:47+01:00" private="0"/>
</bookmarks>



- http://www.kreuzz.com/api/links/bookmarks/update/

Action :
Return the date/time of the last update of bookmarks. Format: ISO 8601.
Example : 
URL : http://www.kreuzz.com/api/links/bookmarks/update/

<update time="2006-10-31T22:37:03+01:00"/>



- http://www.kreuzz.com/api/links/bookmarks/add/

Action :
Add a bookmark.
Parameters :
- url (required) : Url to add
- title (required) : Bookmark's title
- tag (required) : Bookmark's tag(s), separated by commas
- description (optionnal) : Bookmark's description
- private (optionnal) : Add as private link, value : 0 or 1
Example : 
URL : http://www.kreuzz.com/api/links/bookmarks/add/?url=http%3A%2F%2Fgoogle.com%2F&title=Google&tag=search,engine

<result code="done" />



- http://www.kreuzz.com/api/links/bookmarks/delete/

Action :
Delete a bookmark.
Parameters :
- url (required)
Example : 
URL : http://www.kreuzz.com/api/links/bookmarks/delete/?url=http%3A%2F%2Fwww.google.com%2F

<result code="done" />