OpenTV ENTera & OpenTV Platform Documentation
OpenTV ENTera & OpenTV Platform Documentation
Breadcrumbs

Ingesting a deep link

To create a deep link, send a POST request to:

https://<host>:<port>/metadata/content/v1/deepLinks

  • Content-Type: application/json

All of the following arguments are part of the request body:

  • Either:
    id – the ID of the technical content, orBoth providerId and providerResourceId

  • name – the name of the deep link

  • start – the validity start date of the deep link

  • end – the validity end date of the deep link

  • contentRef – the ID of the deep link, expressed asEither:id – the ID of the editorial content, orBoth providerId and providerResourceIdtype – the type, one of editorialContent, contentGroup, or event

  • type –the type of device that the deep link is applicable for. This allows you to target different deep links to different device types. Deep links can also be universal (that is, applicable for all device types).

  • action – the action to take when the user follows the link (for example, open the provider's application)

  • url – the URL of the deep link

The following arguments (all in the request body) are all optional.

However, they may be required by ION (if you are using it). These are indicated with an asterisk (*).

  • profileIdSet – references to the ID(s) of the profile(s) that characterise the deep link (semicolon-separated list)

  • isOriginal – whether the content is original or not (that is, typically only available from that content provider).

  • resolutions – the resolution(s) in which the content is available (e.g., HD or UHD).

  • playbackParams – opaque parameters required by the target platform

  • playbackOptions – the playback options:price – the pricedefinition – the definition (e.g., HD)currency – the currency that the price is expressed inlicense – the license

  • metadataSet – a set of locale-specific metadata blocks, each of which has:
    locale* – the locale for the metadata element. If locale is set to none, the metadata block that it applies to is the default – it is the one that is used if there is no metadata block for the user's locale.metadata – a block containing one or more key/value pairs in the following form:[{ "key": "<key_name>", "value": "<value>"}]

A successful request returns an HTTP 201 status. The response body contains the URI of the newly-created technical content.

A bad request returns an HTTP 400 status.

For full details of this API, see Content and Product Manager (CPM) API documentation: content v1.