API Documentation (1.1.1) [latest]
Following this section, goes to provide all description fields of api's.
ℹ️ Remember that to use the test environment, you must use the following url prefix:
https://test.osteocom.me/sv6
While for production environment must use this link:
https://www.osteocom.me/sv6
POST Authorization API
/contentLicensing_login
<>
The Authorization api provides the access all other subsequent calls. You need two fields, clientId and clientSecret,
you will use the returned token in the request header of your next calls, without it, you will not be able to do other calls.
<>
The partner's unique client ID. Provided according with osteocom.
The secret key provided according with osteocom.
Token used for subsequential calls as Bearer Token in the requests header.
| Status Code | Description |
|---|---|
200 OK | A valid JWT token. |
401 Not Authorized | Unknown client |
POST Catalog API: Content catalog access
/contentLicensing_catalog
<>
It access the Osteocom content catalog, which has already been pre-agreed between the parties.
At this stage, you access the necessary information about the available content.
Each channel has its own data depends on its preconfigurated language as according between osteocom and the partner
including exceptions for some fields that, if unnecessary, according with partner and osteocom, they
cannot provided or passed with no value.
<>
Bearer token
The partner's unique client ID
catalogType: Array of ObjectsThe catalog is an array containing objects. Each object represents a channel with its associated details like authors, images, and videos.
It is used in the purchase api as a parameter both for purchasing the channel in the form of productId and for gaining access to the video.
authorsType: ArrayContains references to the authors, specifically the name and image if any, for each author.
Author's name
Author's image URL
Background image URL for the channel
Cover image URL for the channel
Trailer video URL for the channel
Price of the channel content
A channel title realated to the channel language
A channel subtitle related to the channel language
An osteocom html description that describe the channel.
videoType: Array
Unique identifier for the video
Background image URL for the video
Cover image URL for the video
mp4 trailer for the video
authorsType: ArrayContains references to the authors, specifically the name and image if anyfor each author
Author's name
Author's image URL
A video title realated to the channel language
Type: StringManages
A video subtitle related to the channel language
An osteocom html description that describe the video.
duration of a video in seconds
the quality of the video: i.e. FULLHD
audioType: Array
the language of the audio translation: i.e. italian or english
Status Code | Description |
|---|---|
200 OK | Catalog is returned |
404 Not Found | Catalog not found |
500 Internal Server Error | Unexpected error |
POST Content Access Authorization
/contentLicensing_contentAccessAuthorization
<>
Manages the purchase of content. Send Osteocom user and purchase details (including contents chosen and their own price).
After processing this data, the user is authorized to access purchased content.
<>
Bearer token
Unique identifier for the client.
This field id is provided by the partner. It represent the unique identifier 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 customer. Osteocom manages this fields only for content authorization access and for user token creation.
User Id provided by partner.
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 considered optional.
User's email address.
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.
User's name.
User's surname.
products*Type: Array of ObjectsProducts is an array containing objects. Each object represents a products with the associated price.
Specifies the price of that product.
The channelId used for identify the channel purchased by the customer. This field is mandatory passed to osteocom requests when required.
A token for accessing purchased content.
| Status Code | Description |
|---|---|
200 OK | Purchase successful. |
400 Email field required. | When email field is required. |
403 Unformatted email | When email field is required. |
500 Internal Server Error | Unexpected error. |
POST Video API
/contentLicensing_videoAccess
<>
Allows end users to access purchased content. Verifies permissions and grants access if everything is correct.
The api outcome is a token that you can use by embedding into our provided url within an iframe;
see the section: Iframe-Based Video Access.
<>
Bearer token mandatory
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 customer. Osteocom manages this fields only for content authorization access and for user token creation.
The partner's unique client ID
Unique identifier for the video
Access key that authenticates the user
A token that must be used as parameter into a dedicated url.
Status Code | Description |
|---|---|
200 OK | A signed URL for the video is returned |
401 Not Authorized | The client is not authorized |
401 Token Expired | Token video has expired. |
404 Not Found | Video not found. |
500 Internal Server Error | An unexpected error occurred |
POST Revoke the access to the content
/contentLicensing_revocateActivation
<>
Osteocom provides an additional api so that you can revoke the access to the customer if he is malevolent about payments etc.
You can do this operation at any time.
<>
Bearer token mandatory
The partner's unique client ID
The channelId related to the product.
User Id provided by partner.
A returned userId of the customer
A returned date of the cancellation.
Status Code | Description |
|---|---|
200 OK | Revocation successful. |