stoney core: REST API: Difference between revisions

Revision as of 08:59, 16 October 2013

The Web API will be implemented as a first-class citizen
- It provides all the available functions and data to its clients
- Serves as a data and business logic abstraction layer
The web API wil be implemented using HTTPS and REST principles
Multiple authentication methods are possible
- Basic HTTP-Auth
- X509 Certificate based authentication
- API key with shared secret
- Access tokens
versioned API (preferred through URI)

Why a Web API?

Separation and abstraction of data and business logic
Support for multiple clients
- HTML/JS for selfcare Web GUI
- Command line interface for easy scripting
- Integration into third party provisioning systems for resellers

On the Yii PHP Framework Homepage: Extensions tagged with "rest"
- On the Yii PHP Framework Homepage: RestfullYii or on GitHub: RestfullYii
On the Yii PHP Framework Homepage: Extensions tagged with "api"

@@ Line 1: / Line 1: @@
+== Web API ==
+* The Web API will be implemented as a first-class citizen
+** It provides all the available functions and data to its clients
+** Serves as a data and business logic abstraction layer
+* The web API wil be implemented using HTTPS and REST principles
+* Multiple authentication methods are possible
+** Basic HTTP-Auth
+** X509 Certificate based authentication
+** API key with shared secret
+** Access tokens
+* versioned API (preferred through URI)
+Why a Web API?
+* Separation and abstraction of data and business logic
+* Support for multiple clients
+** HTML/JS for selfcare Web GUI
+** Command line interface for easy scripting
+** Integration into third party provisioning systems for resellers
+*
+=== Yii related API modules ===
 * On the Yii PHP Framework Homepage: [http://www.yiiframework.com/extensions/?tag=rest Extensions tagged with "rest"]
 ** On the Yii PHP Framework Homepage: [http://www.yiiframework.com/extension/restfullyii/ RestfullYii] or on GitHub: [https://github.com/evan108108/RESTFullYii RestfullYii]