The eZ Publish 5 REST API allows you to interact with an eZ Publish installation using the HTTP protocol, following a REST interaction model.
The REST API is available at the URI
/api/ezp/v2. The API from eZ Publish 4.x remains available at the same URI,
/api/ezp/v1. HTTPS is available as long as your server is properly configured. Refer to the Getting started page to start using the API.
REST (REpresentationnal State Transfer) is a web services architecture that follows the HTTP Protocol very closely. The eZ Publish 5 REST API supports both JSON and XML, in terms of request format.
The API provides a set of URIs, each of them identifying and providing access to operations on a certain resource. For instance, the URI
/content/objects/59 will allow you to interact with the Content with ID 59, while
/content/types/1 will allow you to interact with the ContentType with ID 1.
It uses HTTP verbs (
POST, but also
DELETE, etc...), as well as HTTP headers to specify the type of request. Depending on the used HTTP verb, different actions will be possible. Example:
GET /content/objects/2will provide you with data about Content #2,
PATCH /content/objects/2will update the Content #2's metadata (section, main language, main location...),
DELETE /content/objects/2will delete Content #2,
COPY /content/objects/2will create a copy of this Content.
On top of verbs, HTTP request headers will allow you to personalize the request's behavior. On every resource, you can use the Accept header to indicate which format you want to communicate in, JSON or XML. This header is also used to specify the response type you want the server to send when multiple ones are available.
Accept: application/vnd.ez.api.Content+xmlto get Content (full data, fields included) as XML
Accept: application/vnd.ez.api.ContentInfo+jsonto get ContentInfo (metadata only) as JSON
Other headers will be used in HTTP requests for specifying the siteaccess to interact with, and of course authentication credentials.
Responses returned by the API will also use custom headers to indicate information about the executed operation.