Download OpenAPI specification:
The Content Licensing integration API
| clientId required | string The client's unique identifier |
| clientSecret required | string Secret token held by the partner |
{- "clientId": "string",
- "clientSecret": "string"
}{- "token": "a_jwt_valid_token"
}| clientId required | string The client's unique identifier |
{- "clientId": "string"
}{- "idChannel": "string",
- "authors": [
- {
- "name": "string",
- "image": "string"
}
], - "background": "string",
- "cover": "string",
- "trailer": "string",
- "title": "string",
- "subtitle": "string",
- "htmlDescription": "string",
- "price": 0,
- "video": [
- {
- "videoId": "string",
- "authors": [
- {
- "name": "string",
- "image": "string"
}
], - "background": "string",
- "duration": 0,
- "cover": "string",
- "trailer": "string",
- "title": "string",
- "subtitle": "string",
- "htmlDescription": "string",
- "videoQuality": "string",
- "audio": [
- "string"
], - "captions": { }
}
]
}| clientId required | string The client's unique identifier |
| userId required | string The client's unique identifier. This field id is provided by the partner. It represent the unique indentifier for the user. The partner can choose it depending on how he thinks it is more manageable for him handle this field. The identifier must not have a specific formatting for osteocom. The most important thing is that must be unique for identify the custemer. Osteocom manages this fiels only for content authorization access and for user token creation. |
string This field becomes mandatory if partner gave permission to osteocom about marketing consent. The email must be a valid formatted email i.e. test@domain.com, otherwise the field is considerated optional | |
| marketingConsent | boolean This field is about marketing consent if the customer decide to give the permission for receiving marketing contents i.e. newsletters. It is set to false value by default. |
| name | string User's first name |
| surname | string User's last name |
required | Array of objects (contentLicensing_contentAuthorization_products) |
{- "clientId": "string",
- "userId": "string",
- "email": "string",
- "marketingConsent": false,
- "name": "string",
- "surname": "string",
- "products": [
- {
- "productId": "string",
- "price": 0
}
]
}{- "token": "userAccessKey"
}| clientId required | string |
| userId required | string The client's unique identifier. This field id is provided by the partner. It represent the unique indentifier for the user. The partner can choose it depending on how he thinks it is more manageable for him handle this field. The identifier must not have a specific formatting for osteocom. The most important thing is that must be unique for identify the custemer. Osteocom manages this fiels only for content authorization access and for user token creation. |
| videoId required | string Unique identifier for the video |
| userAccessKey required | string Access key that authenticates the user |
{- "clientId": "string",
- "userId": "string",
- "videoId": "string",
- "userAccessKey": "string"
}{- "tokenAuthVideo": "a_token_video"
}| clientId required | string The client's unique identifier |
| userId required | string User Id provided by partner. |
| channelId required | string Unique identifier for the channel |
{- "clientId": "string",
- "userId": "string",
- "channelId": "string"
}{- "userId": "email_user",
- "cancelationDate": "024-00-00T00:00:00.000Z"
}