API

This is a discussion and planning page for implementing an application programming interface (API) for stikis. Such an interface would allow third-party programs to access the site and add and edit stikis and pages. This page contains technical details about the functioning of the stikis.com website and is not intended as a general help topic. If you are looking for general help information, you should instead start at the main help page for the site.

Please note: The information on these pages is incomplete, unfinalized and subject to change. It is likely that the API will alter from what is currently specified as it stabilizes. I have tried to make note of where changes are likely, or where the current implementation is incomplete. Also note that the authentication system has not been extended to allow for api access so much of what is documented here will only work through a client (eg, browser) that can log in to the system and maintain session state. My intention is to use api keys to provide programmatic access to the api in the future.

Available Resoruces

The API is built around 3 main resources, Pages, Stikis, and Content. Each page can contain many stikis, and each stiki can contain a single content, as shown in the following diagram.

[ pages ] 1 – * [ stikis ] 1 – 1 [ content ]

Details on each of these resources and the actions provided for them are provided on their respective pages.