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

Ingesting a product

Request

To ingest a product, send a POST request to:

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

Ingesting a product does not associate any content with it. To associate content with the product, see Ingesting a product link.

Headers

  • Content-Type: application/json

Mandatory fields

  • type (one of transactional , subscription, capability, or ppv)

  • name

  • providerId

  • providerResourceId

Example

A request with this payload creates the specified product:

JSON
{
    "type": "transactional",
    "name": "NAME_01",
    "providerId": "PROVIDER_ID_001",
    "providerResourceId": "PROVIDER_RESOURCE_ID_001"
}

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.

All PUT and POST calls to CPM are validated by the Validation Service. If there is a problem with the data you are submitting, you will receive one of the following:

  • Error – the data is invalid, so the request fails.
    The error message will indicate which data is invalid and why.

  • Warning – there is an issue with the data that does not prevent it from being added/updated in CPM, but that you need to be aware of.
    For example, if a mandatory field has no value for a non-primary locale (but the same field for the primary locale does have a value), you will get a warning rather than an error.
    The warning message will indicate which data is invalid and why.

Note that there are still conditions where a request can pass validation, but fail when it reaches CPM, so you must handle such responses in an appropriate way too.

In addition, all such errors and warnings:

  • Are available as a report in Data Warehouse (errors only).

  • Generate alert emails that are sent to the email addresses that were configured when the system was deployed.

Note: this data only becomes available in the report 60–90 minutes after the error occurs (and the email is sent).




Example

A successful request returns a payload that looks like this:

JSON
{
    "self": "/commercial/v1/products/PROVIDER_ID_001_PROVIDER_RESOURCE_ID_001"
}

See also

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