Overview

From API Documentation

(Difference between revisions)
Jump to: navigation, search
(Rezora REST API Documentation)
(Rezora REST API Documentation)
 
(9 intermediate revisions not shown)
Line 1: Line 1:
-
'''MediaWiki has been successfully installed.'''
 
-
 
-
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
 
-
 
== 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 newsletters.
+
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 requests are all used. Resource representations may be in JSON, XML, or URI-encoded text, as specified in each request.
+
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 12: 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.
+
* [[Common Behaviors]] that apply across all requests and responses.
-
    * Resource models, which describe the data structures used in requests and responses.
+
* [[Resource Definitions]], which describe the available data structures and their usage.
-
    * The requests that may be sent to Rezora resources and the responses expected.
+
* [[Code Examples]] that demonstrate real-world usage scenarios.
-
 
+
-
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.
+
-
 
+
-
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
+
-
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
+
-
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
+

Latest 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:

Personal tools