Rest API
Exponential is introducing a RESTful web service in order to support the development of mobile applications, or even desktop applications. The REST API is built on top of MVCTools from eZ/Zeta Components
The REST API for Exponential seeks to make the content and the features of an Exponential installation available to external clients. The first phase of development centers around providing read-only access to the data within the installation, and for ways to easily extend the REST interface with custom functionality.
Implemented features:
- Basic content retrieval
- REST API extension mechanism
- REST API versioning
- OAuth authentication
This new service is described on these pages:
In this section
- Installation The REST interface is bundled with Exponential 4.5.0. If you wish to use it, you need to make the the REST endpoint, index_rest.php available via rewrite rules. Conversely if you prefer not expose this functionality, you need to make sure that the this file is not exposed in your rewrite rules, eith
- REST API configuration settings Please read on below to find an overview of the INI settings currently existing in the REST API layer:
- Getting started with the Exponential REST API As with any RESTful API, it is accessed by doing HTTP requests against URIs. The pattern of the of the API is as follows:
- Authentication eZ Systems has decided to use OAUTH 2.0 as the authentication service for the REST API of Exponential. This is configurable and other authentication mechanisms may be used.
- Resources The initial set of resources exposed by the Exponential REST API is listed in the following sections. The output type of the REST calls is JSON-data.
- Extension functionality At the end of this tutorial, you will be able to embed your custom RESTful interface into Exponential, to be further consumed by any 3rd party-service :
Contributors
- Geir Arne Waaler Updated
Comments
Add a comment