Documentation Center

Content Delivery API ref introduction

Content Delivery provides application developers with an XQuery API and a RESTful API.

XQuery API

Content Delivery provides an XQuery API to create, update, read and delete application data. The XQuery API is based on Java Servlets and has more complex URI structure compare to RESTful API.

The base URI used to access the XQuery API begins with: http(s)://contentdelivery.lc.example.com/ContentDelivery/web, where lc refers to an example related to Content Delivery, and contentdelivery specifies it further as a delivery server.

RESTful API

Content Delivery provides a simplified URI structure for accessing specific parts of the database, such as the content module and the user interface resources. These adhere to RESTful URI structures.

Based on REST principles, you can easily develop and deploy web-based custom tools and applications for Content Delivery. The Content Delivery RESTful API is conversational: you must first obtain the web session id using the login API (which is part of the Content Delivery session XQuery API package) before performing any other operation, such as create, update, read, or delete on application data.

The data returned to clients will be in the format of the specified value of the <Accept> header parameter. Any failure inside this API will return an OK HTTP response. Depending on the value of the <Accept> header parameter, an application error code and message will be returned in either XML or JSON format. The HTTP error codes 3xx, 4xx, and 5xx can be received by clients, but those will be issued by the web server and not by the Content Delivery RESTful API.

The base URI used to access the RESTful API begins with http(s)://contentdelivery.lc.example.com/ContentDelivery/v2