• Topics
• FAQs
• API Documentation
  • Sample Applications
  • Prototype Resource
  • Page Resource
  • Layer Resource
  • Discussion Resource
• Professional Services
• User Experience Dictionary
• Important Notice

API Documentation

Introduction

The pidoco API provides an interface to fellow developers who want to include pidoco prototypes into other third party applications or write their own simple tools around pidoco. We tried our very best to follow the REST principle. Using of the HTTP request methods POST, GET, PUT, DELETE we allow the different operations to create, read, update, or delete a resource. Each resource is mapped to a specific URL as described on the sub-pages of this section.

Get Support

If you plan to use our API in your application, please don't hesitate to get in touch with us for support. We'd love to help you figuring things out, because it will improve this documentation section as well.

The description in here is not complete yet. If you need further call types, there might be some available already but are not mentioned. This is because the API is not yet stable and things will change the next months.

API Keys

A call to the API must include an API Key as a Get parameter:
https://pidoco.com/rabbit/api/some/url?api_key=asdf
where 'asdf' is the API Key. As always with pidoco, you have to use secure access via the HTTPS protocol.

There are two levels of access rights for an API Key, either read-only or read-write access. You may retrieve a read-only API Key for a certain prototype from within the editor. In the 'Get a link to this prototype' dialog box, the links all contain an API Key. For now, you may only get a read-write API Key by contacting us.

Request Rate Limits

Up to now we have not implemented any limits in the number of requests you are allowed to submit. However, this does not mean that you should not consider to reduce the requests to a minimum while using our API. Otherwise this may change quite soon.

We do implement the Last-Modified HTTP response header, which you may use to check whether a resource has been changed in the meantime. Please do also consider using the If-Modified-Since HTTP request header to reduce server load on our side.

Data Types

The main data type for using our API is the JSON format. Most requests will deliver JSON and when posting data to our server we expect JSON code. However, in some cases we do also deliver different formats, e.g. PNG images or XHTML pages. We offer two ways to request a certain data type: either use the Accept HTTP request header to specify the desired type, or use a simple 'file' extension to the URL like:
https://pidoco.com/rabbit/api/some/url.json?api_key=asdf
which is equivalent to the Accept header application/json.

Last Update

On September 20th, 2010