What is REST
REST (REpresentational State Transfer) is a framework for API design based on the standard HTTP protocol. REST partitions an API into a series of resources, each typically relating to a specific feature or logical part of an application.
A third-party program interacts with a resource through one or more defined operations (based on standard HTTP methods such as GET). For example, admin user accounts might be represented by a "users" resource, with the operation "getUserDetails" to retrieve a named user profile.
Each resource in a REST API is identified by a URI (Uniform Resource Identifier) address. To interact with the API, third-party programs direct HTTP requests to the URI of the resource and operation of interest (subject to the normal authentication processes associated with accessing a Coro subscription).
A RESTful API makes use of standard HTTP methods to perform requests and the full range of HTTP return codes in responses. The Coro API supports the following HTTP methods:
| Method | Description |
|---|---|
| GET | Obtain a representation of the resource without altering the stored state |
| POST | Store a new instance of a resource using the properties supplied in the request body |
HTTP response codes and their meaning are provides in the resource definitions.
Coro resources are represented and stored as JSON (JavaScript Object Notation) structures. Requests and responses that interact with Coro through the REST API must adopt the same format.
In most cases, operations require you to define parameters in the query string (GET operations) or request body (POST operations) sent to the resource. The specification of each resource and operation is provided in this portal.