Using REST APIs

Liferay DXP’s headless REST APIs can be used with any REST client you prefer. The only usual requirements are setting up the Authentication header (either OAuth, Cookie, Basic…) and the Content-Type header if you are creating content.

Our recommendation for JavaScript applications is to use fetch directly, like this:

fetch(`http://localhost:8080/o/headless-delivery/v1.0/sites/${SITE_ID}/structured-contents/'`, 
    {
        method: 'GET',
        headers: {
            'Authorization': `Basic ${BASIC_AUTH}`
        }
    }
);

Or for a POST request:

fetch(`http://localhost:8080/o/headless-delivery/v1.0/sites/${SITE_ID}/structured-contents/`, 
    {
        method: 'POST', 
        headers: {
            'Authorization': `Basic ${BASIC_AUTH}`,
            'Content-Type': 'application/json'
        }, 
        body: JSON.stringify(
            {
                "title": "New appointment",
                "contentStructureId": STRUCTURE_ID,
                "contentFields": [
                    {
                        "name": "User",
                        "value": {
                            "data": USER,
                        }
                    },
                ]
            }
        )
    }
)

Here are two examples of JavaScript applications using the Headless REST APIs:

• Alexa skill using Headless REST APIs with node-fetch.
• Example API from scratch using REST Builder.