OTT APIs: Version 2.0

Overview
OTT APIs
OTT Service Callbacks
MarketONE Developer Portal
Revision History

Overview

This section contains details on the Version 2.0 over-the-top (OTT) provider API, as well as the OTT service callbacks that MarketONE supports.

OTT APIs

The following table lists and describes the API concerned with updating the status of partner subscriptions.

API	Description
PUT /v2/partnerSubscription/{id}	This API updates the status of the partner subscription. Note: This API is only available for OTTs.

OTT Service Callbacks

Callbacks allow your system to know about (and act upon) MarketONE events as they occur, without requiring that you pull data via our API.

You can provide a callback URL, and when those events happen MarketONE will immediately generate a Push Notification as an HTTPS POST request with a JSON message. MarketONE callback actions are intended to be actionable on their own, not typically requiring a subsequent API call. As such they will include the full related object(s) in JSON format.

You will need to configure the following:

Endpoint:
- These should be URLs, optionally with a port number. For example: https://acme.company.com/m1-subscription-events:443
Retry Options:
- Count: the number of times you want MarketONE to retry HTTP POST calls.
- Interval: the number of seconds between retries.
Error Email Address: The email address to receive optional error notification.
An API Key for additional security which will be added in an authorization header.

The following table lists and describes the OTT service callbacks that MarketONE supports.

Callback	Description
AddSubscription	This callback action is triggered when a new subscription is created by MarketONE. This will be invoked by MarketONE to notify the OTT when the user purchases a subscription from the communications service provider (CSP) website, or a re-provision request is triggered by the customer or a CSR. Note: It is expected that the OTT performs any applicable provisioning if the callback is configured via the developer portal, and returns the mandatory fields described in the MarketONE OTT Service Callbacks section on the MarketONE Developer Portal.
UpdateSubscription	This callback action is invoked by MarketONE to notify the OTT when the user upgrades, downgrades the service subscription via the CSP website. Note: The OTT should handle this action to allow for any applicable provisioning.
DeleteSubscription	This callback action is triggered to notify the OTT when the user cancels the subscription, or when the subscription is no longer valid based on the status of their billing account. Note: The OTT must handle this action to allow for any applicable deprovisioning.

MarketONE Developer Portal

Please refer to the MarketONE APIs - V2 and the MarketONE OTT Service Callbacks sections under the API Reference menu on the MarketONE Developer Portal for OpenAPI instances of these API and service callbacks.

Revision History