What is the eCirkit API?

The eCirkit API (Application Programming Interface) is a way for developers to build tools that can interact with eCirkit.

How to Access the eCirkit API

To access the eCirkit API, form a GET request using the following syntax: 

http://www.ecirkit.com/ecapi/get?{PARAMETERS}

where PARAMETERS are:

REQUIREMENT
(
*
= required)
(- = optional)
 PARAMETER DESCRIPTION NOTES
* key API key This is the key that you were assigned when you registered for an API key.
* uun eCirkit Web Address name for which you want data returned For the eCirkit Web Address "http://www.ecirkit.com/thesilverfox", "thesilverfox" is the eCirkit Web Address name.
- format data return format Options are "json" or "xml". Default is "json".
- do action to perform You may use comma-separated values to include multiple actions.

ACTION DESCRIPTION
blogs

returns content of all blog entries (can limit by using "rs" and "rl" parameters)

Example Request: Get 2 blog entries from thesilverfox (to get all blog entries, remove "&rl=2")

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=blogs&rl;=2
blogsCount

returns count (number) of all blog entries

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=blogsCount
videos

returns content of all video entries (can limit by using "rs" and "rl" parameters)

Example Request: Get 

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=videos
videosCount

returns count (number) of all video entries

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=videosCount
rss

returns a list all RSS feeds plus first 10 topics in each feed

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=rss
rssCount

returns count (number) of all RSS feeds

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=rssCount
forSale

returns a list of all For Sale items

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=forSale
forSaleCount

returns count (number) of all For Sale items

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=forSaleCount
contactsCount

returns count (number) of all contacts

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=contactsCount
photoGalleries

returns a list of galleries and count of photos in each gallery - returns null if no galleries exist

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=photoGalleries
photos

returns a list of photos in the root gallery by default, or in the gallery specified by "gid" parameter

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=photos
bookmarkFolders

returns a list of bookmark folders and count of bookmarks in each folder - returns null if no folders exist

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=bookmarkFolders
bookmarks

returns a list of bookmarks in the root bookmark folder by default, or in the folder specified by "bfid" parameter

Example Request:

http://www.ecirkit.com/ecapi/get?key=XXXX&uun;=thesilverfox&do;=bookmarks
- rs result set start Used for pagination.
- rl result set limit Used for pagination. May be used in combination with "rs" to, for example, get 2 results starting with the 10th result (&rl;=2&rs;=10).
- gid gallery id Specify a gallery from which to get photos.
- bfid bookmark folder id Specify a bookmark folder from which to get bookmarks.

Error Codes