Creating a third-party product

Overview

For each third-party offering that you want to make available to your customers, you must create a product in OpenTV Platform.

For example, if you are only enabling Netflix and want to allow your customers to purchase any of the three Netflix plans, you should create three products: one for Netflix Basic, one for Netflix Standard, and one for Netflix Premium.

There are two ways to create a third-party product:

• In Operator Console (OpCon) – see Create a new product.

• Via an API call, as explained below.

Request

To create a third-party product, send a PUT request to:

http://<server>:<port>/cpm/commercial/v1/products

Headers

• Content-Type: application/json

Mandatory fields

• type (in this case, thirdParty)

• name – the product name

• providerId – the provider ID

• providerResourceId – the ID of the resource

The providerId and providerResourceId must match the agreed merchant ID and merchant product in the Bango system and be aligned with the merchant offers.

(“Merchant” here refers to the third-party service provider, for example, Netflix or Disney+.)

Example

A request with this payload creates the specified product:

{
    "type": "thirdParty",
    "name": "Netflix Basic",
    "providerId": "Netflix_EU",
    "providerResourceId": "B_BUNDLE_BASIC"
}

Response

A successful request returns an HTTP 201 status and a link to the newly created product.

A bad request returns an HTTP 400 status.

Example

A successful request returns a payload that looks like this:

{
    "self": "/commercial/v1/products/Netflix_EU_B_BUNDLE_BASIC"
}

See also

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