Overview: The Asset Push API is used to send IRIS.TV content for ingestion, in many acceptable formats, including the Standard Content Feed Ingestion or Custom Content Feed Ingestion metadata requirements.
Asset Push API Call
IRIS.TV will accept assets sent via HTTPS POST request to the base URL that
follows, and requires several query parameters and headers for the content to be
accepted.
<https://api.iris.tv/publisher/asset>
The following query parameters are required:
- access_token: token assigned to the publishers parent account (parent media company)
- client_token: token assigned to the publishers child account (site, app or channel)
The body of the POST request is recommended to be JSON or XML data. The exact format for its contents can either conform to the Standard Content Feed Ingestion or your existing format.
NOTE: If you're not using the Standard Content Feed Ingestion, please discuss with your technical account manager so IRIS.TV can configure the API to accept your data.
The following HTTP headers are accepted:
- Content-Type: This required header identifies the type of data which is sent in the body (e.g. application/json or application/xml)
- X-Iris-Content-Source: The exact name of the content source configured for the assets to be sent. If the publisher’s account has exactly one content source configured, this header can be omitted.
Asset Push API Response
The API will respond with a JSON document.
In the case of a success, the HTTP response code will be 200, and the body will include the following values:
- success: This will be set to “true”
- iris_id: The IRIS ID for the request
NOTE: IRIS.TV will only return encoded values for segments that have already been added via the shared Google Sheet.
API Failure Responses
In the case of a failure, the HTTP response code will indicate the type of error (examples below), and the body will have the field errors containing an array of strings identifying one or more errors which occurred during the processing of the request. Fixing all the errors listed in the array does not guarantee a successful request, as new problems may be revealed by fixing existing ones.
Examples of HTTP response codes used by this endpoint:
- 401 Unauthorized: no access_token was provided, or an invalid access_token was provided.
- 403 Forbidden: no client_token was provided, an invalid client_token was provided, or the client_token does not grant access to the provided content source
- 400 Bad Request: the passed asset did not include an id or url, or it did not contain them at the location IRIS.TV expected based on your communication with your TAM
- 500 Internal Server Error: the IRIS.TV server encountered an error and could not process your asset. At the time of request, please retry. Please contact your TAM with the details of the request which failed including the asset to be passed as well as the content source and tokens used to make the request, as well as the date and time when the request was made.
- 503 Service Unavailable: The IRIS.TV server encountered an error and could not process your asset. At the time of request, please retry. Please contact your TAM with the details of the request which failed including the asset to be passed as well as the content source and tokens used to make the request, as well as the date and time when the request was made.
Example Error responses from the API:
{"errors": ["Missing access token"]}
{"errors": ["Missing client token"]}
{"errors": ["Could not find a content source by that name"]}
{"errors": ["Asset missing id" "Asset missing url"]}