Revision as of 15:58, 18 November 2015

RESTfull

In computing, Representational State Transfer (REST) is the software architectural style of the World Wide Web. REST gives a coordinated set of constraints to the design of components in a distributed hypermedia system that can lead to a higher-performing and more maintainable architecture.

To the extent that systems conform to the constraints of REST they can be called RESTful. RESTful systems typically, but not always, communicate over HTTP with the same HTTP verbs (GET, POST, PUT, DELETE, etc.) which web browsers use to retrieve web pages and to send data to remote servers.REST interfaces with external systems using resources identified by URI, for example /people/tom, which can be operated upon using standard verbs, such as DELETE /people/tom.

Reference: Wikipedia

TelcoBridges RESTfull Northbound Interface

As of Release 2.9, TelcoBridges gateways support a RESTful configuration interface using JSON for data exchange.

Supported RFCs

TelcoBridges supports the following RFCs for RESTful API:

API overview

Supported Methods

• GET : List collection entries, or Read a specific configuration entry

 GET /users
 -> Code    : HTTP/1.0 200 OK
 -> Content : {"root":{}}
 GET /users/root
 -> Code    : HTTP/1.0 200 OK
 -> Content : {"name":"root","user_group":"Admin","pass":"Not Shown"}

• PUT : Update a configuration entry

 PUT /users/root
 <- Content : {"pass":"MyNewSecret"}
 -> Code    : HTTP/1.0 200 OK

• POST: Create a configuration entry into a collection

 POST /users
 <- Content : {"name":"someone","user_group":"readonly","pass":"xyz"}
 -> Code    : HTTP/1.0 200 OK

• DELETE: Delete a configuration entry from a collection

 DELETE /users/someone
 -> Code    : HTTP/1.0 200 OK

Collections

Plural form path generally represent a collection of configuration entries. For example, the path where users configuration entries are grouped into

 /users
 /configurations

Entries

JSON status message

HTTP status code

HTTP headers