Introduction
The Remote Campaign API allows remote control of the delivery of a campaign by an external entity. The owner of the private exchange must create the campaign and allow its control through this API. (It is set to off by default.) This can be done on the Campaign Edition main screen.
It is the responsibility of the owner of the private exchange to configure the campaign as usual (linking zones, targeting, etc.)
Authentication
When enabling remote control for a campaign, the system provides a unique authentication token. For each campaign there is only one active token and each token can be used for only one campaign. It is, therefore, both an authentication and an identification parameter.
Except for details about the authentication token, the Remote Campaign API uses the general principles common to all our APIs and described in SFX APIs: Using JSON.
Commands
The Remote Campaign API consists of four commands:
| Command | Used to: |
|---|---|
| startCampaign | Start delivering a campaign |
| getCampaignInfo | Retrieve campaign information (including status) |
| stopCampaign | Stop delivery of a campaign |
| getCampaignStats | Retrieve delivery information about the campaign |