Authentication

When humans interact with a website or service that requires authentication with a username and password, the webbrowser will simply show a dialog to enter these details. However, when the calls come from an application, this isn’t possible.

For this purpose, a standard exists, called “Basic Authentication”. More information about this technique can be found in an article on Wikipedia.

Including authentication in the request header

In order to send the authentication data with the request, the call needs to include this in the request header.

Here is an example of how this is implemented in our own interactive demo (PHP):

if($type == “XML”) {
  $headers = array(
    ‘Accept: text/xml’,
    ‘Content-Type: text/xml’,
  );
} else {
  $headers = array(
    ‘Accept: application/json’,
    ‘Content-Type: application/json’,
  );
}
$headers[] = ‘Authorization: Basic ‘ . base64_encode($user . “:” . $password);
$data = $_POST[‘body’];

$user and $password are variables that get values assigned elsewhere in the code, they’re not hard coded for obvious reasons.

Current version

The most recently released version of the Revive Adserver REST API is v5.2.0 (publication date April 18, 2024).

See Release Notes

Compatibility

Revive Adserver REST API is compatible with all versions of Revive Adserver v4.x, and v5.x. It may also be compatible with Revive Adserver v3.x (and also with OpenX Source v2.8 and higher), but this can not be guaranteed.

Revive Adserver REST API is compatible with all supported versions of PHP, including PHP 7 and PHP  8.

Also see Technical Requirements, Product Content, and Installation Instructions.