Jivox Workflow APIs
The Jivox Workflow APIs allow a publisher to integrate the Jivox ad/campaign creation workflow with their order entry system.
An ad creation order request will typically be entered first in the publisher's order entry system. An ad creation order request goes through multiple steps – creation of the advertiser account, getting the assets for the ad, creating the various ad sizes, generating preview links, creative approval, creating a campaign and generating tags for the various placements.
This integration allows for the customer's order status to be monitored from a single system as opposed to signing into multiple platforms to check the status of an advertiser's campaign. The Workflow APIs include methods for creating an advertiser account, creating an ad in a specific advertiser account, getting preview links for an ad, creating a campaign for an ad and getting tags for the campaign. This document details these APIs and how to access them. These methods follow the structure of the Jivox Data APIs that are currently supported and available.
API Access
The Jivox Workflow API requires an authentication key. Every API call also requires the identifying parameters to be sent as part of the call. In this API document, the following applies to all APIs:
- All parameters are passed securely as HTTP POST.
- For authentication the following parameters are passed with each call
- apiId – ID that identifies the specific API group
- apiKey – the authentication key
- apiVersion – specifies the version of the API that is being used
- publisherId – ID of the affiliate for which Authentication key is generated
- The requests are made to the Jivox Workflow API server referred to as JIVOX_SERVER in the rest of this document
When a Jivox client first requests access to Workflow APIs, Jivox Support provides:
- API authentication parameters
- Jivox Workflow APIs server JIVOX_SERVER
Server Failure Response
In case of failure for a Workflow API lookup, the following response is returned:
xxxxxxxxxx<jivoxServerResponse><result>FAILED<_result><failureReason>reason for failure<_failureReason><jivoxServerResponse>FAILED_reason for failure_