Overview

From API Documentation

(Difference between revisions)
Jump to: navigation, search
(Rezora REST API Documentation)
(10 intermediate revisions not shown)
Line 1: Line 1:
-
'''MediaWiki has been successfully installed.'''
+
== 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.
-
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
+
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.
-
== Getting started ==
+
The starting point for accessing the API is a URI, supplied by Rezora, which identifies the API and its version.
-
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
+
 
-
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
+
The specification of the Rezora API includes:
-
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
+
 
 +
* [[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.

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