Skip to content

Testing REST API

A standard web browser is not sufficient to fully test the API. You can, however, try opening the root resource with it, using the session authentication: http://example.com/api/ibexa/v2/. Depending on how your browser understands XML, it either downloads the XML file, or opens it in the browser.

The following examples show how to interrogate the REST API using cURL, PHP or JS.

To test further, you can use browser extensions, like Advanced REST client for Chrome or RESTClient for Firefox, or dedicated tools. For command line users, HTTPie is a good tool.

CLI

For examples of using curl, refer to:

PHP

To test REST API with PHP, cURL can be used; open a PHP shell in a terminal with php -a and copy-paste this code into it:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
$resource = 'https://api.example.com/api/ibexa/v2/content/objects/52';
$curl = curl_init($resource);
curl_setopt_array($curl, [
    CURLOPT_HTTPHEADER => ['Accept: application/vnd.ibexa.api.ContentInfo+json'],
    CURLOPT_HEADERFUNCTION => function($curl, $header) {
        if (!empty($cleanedHeader = trim($header))) {
            var_dump($cleanedHeader);
        }
        return strlen($header);
    },
    CURLOPT_RETURNTRANSFER => true,
]);
var_dump(json_decode(curl_exec($curl), true));

$resource URI should be edited to address the right domain.

On a freshly installed Ibexa DXP, 52 is the Content ID of the home page. If necessary, substitute 52 with the Content ID of an item from your database.

For a content creation example using PHP, see Creating content with binary attachments

JS

The REST API can help you implement JavaScript / AJAX interaction. The following example of an AJAX call retrieves ContentInfo (that is, metadata) for a Content item:

To test it, copy-paste this code into your browser console alongside a page from your website (to share the domain):

1
2
3
4
5
6
7
8
9
var resource = '/api/ibexa/v2/content/objects/52',
    request = new XMLHttpRequest();

request.open('GET', resource, true);
request.setRequestHeader('Accept', 'application/vnd.ibexa.api.ContentInfo+json');
request.onload = function () {
    console.log(request.getAllResponseHeaders(), JSON.parse(request.responseText));
};
request.send();

On a freshly installed Ibexa DXP, 52 is the Content ID of the home page. If necessary, substitute 52 with the Content ID of an item from your database.

You can edit the resource URI to address another domain, but cross-origin requests must be allowed first.