OVERVIEW

The Media Syndication API provides integration with different media services (i.e. Facebook, MPX, YouTube, etc.) using two VUALTO concepts; Destinations and Publications.

Destinations represent the target location, such as a Facebook page, and store information related to accessing these targets (i.e. page ID, access tokens, etc.).

Publications represent the content being sent to a Destination, and can contain various forms of metadata depending on the support at the other end. They also contain ‘state’ information depending on what is going on via this API. Every publication must have a Destination, and deleting the Destination will delete any associated publications. Publications are split into Live and VOD through different API routes as the workflows are vastly different.

Global Requirements

Authorisation: Every call to the Media Syndication API requires the following authorisation headers:

Client:     client-name-here
API-KEY:    xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx

If you fail to provide a matching client and API key, you will recieve a 401 Unauthorised.

If you have access to multiple clients, you must query these individually - you cannot specify multiple clients.

For administrators, using the deployed client & authentication key will return results from across all clients.

Route Prefix: Every API route has the prefix /api/. This means that a call documented as GET /destination/ will require a GET request to http://server.url.com/api/destination. Failure to account for this will result in a 404 Not Found.

Other Information

Examples in this documentation are accurate where possible, but a number of the response messages have been made more generic and should not be expected to be verbatim.

Target Enumeration

The Media Syndication API uses ‘Targets’ to refer to the various Media platforms that could be pushed to. This is enumerated within the API to the following:

Facebook = 0
Twitter = 1
YouTube = 2
MPX = 3
Custom = 4

Note: Custom is a unique type, which can be used flexibly. Please refer to the relevant documentation for either Live or VOD publications.

Paginated Responses

For any response that returns a “paginated set of {objects}” it will follow this structure:

{
    "results": [],
    "totalCount": 56,
    "pageSize": 10,
    "pageNumber": 2
}

Supported Syndications

Live Syndication:

Facebook
YouTube
Custom

VOD Syndication:

Facebook
YouTube
Twitter