Overview
From API Documentation
(Difference between revisions)
(→Rezora REST API Documentation) |
(→Rezora REST API Documentation) |
||
| Line 8: | Line 8: | ||
The specification of the Rezora API includes: | The specification of the Rezora API includes: | ||
| - | * [ | + | * [[Common Behaviors]] that apply across all requests and responses. |
| - | * [Resource Definitions], which describe the data structures used in requests and responses. | + | * [[Resource Definitions]], which describe the data structures used in requests and responses. |
* The requests that may be sent to Rezora resources and the responses expected. | * The requests that may be sent to Rezora resources and the responses expected. | ||
Revision as of 06:41, 10 July 2010
Rezora REST API Documentation
This document specifies Rezora's RESTful API for creating and managing Rezora account resources, such as agents, contacts, and newsletters.
Usage of the API is via the HTTP protocol. The GET, POST, PUT, and DELETE requests are all used. Resource representations may be in JSON, XML, or URI-encoded text, as specified in each request.
The starting point for accessing the API is a URI, supplied by Rezora, which identifies the API and its version.
The specification of the Rezora API includes:
- Common Behaviors that apply across all requests and responses.
- Resource Definitions, which describe the data structures used in requests and responses.
- The requests that may be sent to Rezora resources and the responses expected.
The API is accessible by two distinct usage levels: company users, and agent users. The resources made available through the API are grouped according to which usage level has access to them.
