Overview
From API Documentation
(Difference between revisions)
(→Rezora REST API Documentation) |
(→Rezora REST API Documentation) |
||
| (3 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
== Rezora REST API Documentation == | == Rezora REST API Documentation == | ||
| - | This document specifies Rezora's RESTful API for creating and managing Rezora account resources, such as agents, contacts, and | + | This document specifies Rezora's RESTful API for creating and managing Rezora account resources, such as agents, contacts, and distribution lists. |
| - | Usage of the API is via the HTTP protocol. The GET, POST, PUT, and DELETE | + | Usage of the API is via the HTTP protocol. The GET, POST, PUT, and DELETE request methods are all used. Resource representations may be in JSON, XML, or pipe-delimited CSV, 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 starting point for accessing the API is a URI, supplied by Rezora, which identifies the API and its version. | ||
| Line 9: | Line 9: | ||
* [[Common Behaviors]] that apply across all requests and responses. | * [[Common Behaviors]] that apply across all requests and responses. | ||
| - | * [[Resource Definitions]], which describe the data structures | + | * [[Resource Definitions]], which describe the available data structures and their usage. |
| - | * | + | * [[Code Examples]] that demonstrate real-world usage scenarios. |
| - | + | ||
| - | + | ||
Revision as of 16:14, 22 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 distribution lists.
Usage of the API is via the HTTP protocol. The GET, POST, PUT, and DELETE request methods are all used. Resource representations may be in JSON, XML, or pipe-delimited CSV, 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 available data structures and their usage.
- Code Examples that demonstrate real-world usage scenarios.
