Agency Management

getAgencyList

Description: Get a list of all existing agencies

Implementation: URL/agc/lst

Method: GET

Json example:

Method: 
    GET http://api.example.com/agc/lst

getAgency

Description: Get the details of one specific agency

Implementation: URL/agc/[agencyId]

Method: GET

Json example:

Method: 
    GET http://api.example.com/agc/1

addAgency

Description: Add a new agency

Implementation: URL/agc/new

Method: POST/PUT

Parameters:

addAgency
Name Description Allowed Values Required / Optional Default
agencyName name of the agency string required
contactName contact name string required null
emailAddress email address string optional null

Json example:

Method: 
    POST http://api.example.com/agc/new
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "agencyName":"Test new Agency creation",
        "contactName":"Peter Pan",
        "emailAddress":"peter.pan@example.com"
    }

Starting with v4.0, the addAgency function will return full details of the newly created agency, instead of just {“OK”}. This enables developers to quickly retrieve the ID of the newly created entity, and to check the default values assigned to attributes that were not included in the call to create the new entity.


modifyAgency

Description: Modify an existing agency

Implementation: URL/agc/[agencyId]

Method: POST/PUT

Requested parameters:

modifyAgency
Name Description Allowed Values Required / Optional Default
agencyName name of the agency string optional
contactName contact name phone number optional null
emailAddress email address string optional null

Json example:

Method: 
    POST http://api.example.com/agc/1
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "agencyName":"Test new Agency creation - modified",
        "contactName":"Peter B Pan"
    }

deleteAgency

Description: Delete an existing agency

Implementation: URL/agc/[agencyId]

Method: DELETE

Json example:

Method: 
    DELETE http://api.example.com/agc/1

Current version

The most recently released version of the Revive Adserver REST API is v4.2.0 (publication date July 12, 2017).

See Release Notes

Compatibility

Revive Adserver REST API is compatible with all versions of Revive Adserver v4.0 and higher. 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 PHP7.

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

Our Recent Tweets