REST API

Beebotte implements a REST API to interact with the platform. The API uses GET, POST and DELETE requests and encodes data in JSON format. Beebotte server libraries implement this API providing thus a convenient wrapper.

The API provides the means to write and retrieve data as well as a full management of the user's connected channels.

We use a powerfull authentication scheme that garentees the user authenticity and data intergrity. This mechanism is described here.


The API Playground provides detailed description of the different methods. You can also test and play with the API.

Beebotte REST API is implemented in different programming langages, check the Libraries for further details.

Error codes

Bad Authentication

Indicates a missmatch between the provided signature and the expected one.

  • HTTP code: 400
  • Error code: 1101
  • Error message: Bad Authentication Data

Not Allowed

  • HTTP code: 405
  • Error code: 1102
  • Error message: Operation not allowed

Internal Error

Indicates an unexpected internal server error. This is not related to your code.

  • HTTP code: 500
  • Error code: 1201
  • Error message: Unexpected internal error! This is our fault! We do our best to fix things up!

Not Found

Indicates that the requested element was not found

  • HTTP code: 404
  • Error code: 1300
  • Error message: Requested element not found!

Resource Not Found

Indicates that the requested resource was not found

  • HTTP code: 404
  • Error code: 1301
  • Error message: Requested resource not found!

Service Not Found

Indicates that the requested service was not found

  • HTTP code: 404
  • Error code: 1302
  • Error message: Requested service not found!

Channel Not Found

Indicates that the requested channel was not found

  • HTTP code: 404
  • Error code: 1303
  • Error message: Requested channel not found!

Resource Already Exist

Indicates that the resource to add already exist

  • HTTP code: 404
  • Error code: 1304
  • Error message: Requested resource already exists! Request will be ignored!

Service Already Exist

Indicates that the service to add already exist

  • HTTP code: 404
  • Error code: 1305
  • Error message: Requested service already exists! Request will be ignored!

Channel Already Exist

Indicates that the channel to add already exist

  • HTTP code: 404
  • Error code: 1306
  • Error message: Requested channel already exists! Request will be ignored!

Parameter Error

Indicates that the request message parameter format in not valid

  • HTTP code: 400
  • Error code: 1401
  • Error message: Message parameters error!

Bad Request

Indicates request validation error

  • HTTP code: 400
  • Error code: 1403
  • Error message: Bad Request

Type Error

Indicates that the submitted data value does not match the expected type. As an example, if a resource is of type string and the submitted data is a number, this error will be given.

  • HTTP code: 400
  • Error code: 1404
  • Error message: Validation error! Submitted value does not match the expected type!

Bad Type

Indicates that the data type is not known. This error can result when adding a new resource with a vtype unknown to Beebotte.

  • HTTP code: 400
  • Error code: 1405
  • Error message: Bad Type! The given data type is not known; check the documentation for details!

Payload Limit Error

Indicates that the message length exceeds the maximum allowed size.

  • HTTP code: 400
  • Error code: 1406
  • Error message: Message length exceeds maximum payload data limit. Consider splitting ypur data across multiple messages. For current limits refer to the documentation!

Beebotte Documentation