Introduction

This part of the documentation provides a technical specification of the RESTable protocol, used to consume the web services provided by a RESTable application. RESTable can be setup to support additional protocols, for example OData, but for now, let’s focus on the default protocol.

We will only describe the format of REST requests and responses here. For a description of the actual web resources of a specific application – see the documentation provided for that application.

As an API consumer, the application administrator will make resources available for you by creating API keys, and binding certain web resources and methods to them. Different API keys can have different access rights, so make sure to keep your API key secure. When you know the location of the web service – that is – its URI, and your assigned API key, you are ready to begin sending requests to the service.