REST API Documentation

Our REST API gives you access to most of Cobot's features. If you need more endpoints let us know.

General

The Cobot API is a (somewhat) RESTful API, where resources can be accessed by their URLs. All data is returned as JSON. When you POST or PUT data to the API we expect either form encoded data or JSON with the appropriate content type header (application/json). Publicly available information can be accessed without any authentication. For private information you have to authenticate using OAuth 2.

If you have problems accessing our API, again, please ask us.

As a starting point take a look at the source code of our example applications on Github.

You can try out most of these apps from the add-ons directory.

Bots

To build user interface that integrate with Cobot take a look at our Bots – this is a way to build add-ons using client-side JavaScript only. You get OAuth and a few other things for free.

OAuth2 authentication

OAuth is "an open protocol to allow secure API authorization in a simple and standard method from desktop and web applications.". "OAuth 2.0 is the next evolution of the OAuth protocol [..]. OAuth 2.0 focuses on client developer simplicity [...]. It is supported by many popular sites such as Facebook and there are client libraries available for many programming languages.

For information about OAuth2 see the oauth website.

For OAuth2 you need a client id and secret. In order to get those you have to register your application.

API Changelog

We have a changelog for the API, so you can keep up to date.