REST/HTTP Server API

Iotellect Server supports REST API for integration with third-party software systems. You can use REST API requests to work with context variables, functions, and events. You can also evaluate expressions.

In computing, REST (Representational State Transfer) is the software architectural style of the World Wide Web.

REST API Versions

The current version of REST API is v1. The older XML-based version of REST API is a legacy version and may be deprecated in the future versions of Iotellect. If you need the documentation for the old version of REST API, please contact info@iotellect.com.

Message Format

REST API uses JSON data representation. Data that is passed in the requests and responses is in the JSON format.

HTTP Protocols

REST API can use HTTP and HTTPS protocols.

It is recommended to use the HTTPS protocol, because REST API authentication is token-based. Anyone monitoring the HTTP traffic will be able to obtain the token and gain the same access rights as the token owner.

HTTP Methods

REST API supports GET, POST, PUT, and PATCH HTTP methods. These methods support retrieve and update operations on context variables, functions, and expressions. You cannot perform create and delete operations with REST API.

In computer programming, create, read, update, and delete (CRUD) are the four basic functions of persistent storage.

HTTP Status Codes

REST API uses the standard HTTP status codes to indicate the result of a request.

  • 1XX — Informational response

  • 2XX — Success

  • 3XX — Redirection

  • 4XX — Client errors

  • 5XX — Server errors

Was this page helpful?