API Documentation (1.0.0)

Following this section, goes to privide 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://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 jwt token in the request header of your next calls.
<>

Payload

clientIdType: String

The partner's unique client ID

clientSecretType: String

The secret key associated with the client ID

Response

tokenType: String

The generated JWT token

HTTP Status Codes

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.
<>

Header

AuthorizationType: String

Bearer token

Payload

clientIdType: String

The partner's unique client ID

Response

catalogType: Array of Objects

The catalog is an array containing objects. Each object represents a channel with its associated details like authors, images, and videos.

idChannelType: String

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: Array

Contains references to the authors, specifically the name and image if any for each author.

nameType: String

Author's name

imageType: String

Author's image URL

backgroundType: String

Background image URL for the channel

coverType: String

Cover image URL for the channel

trailerType: String

Trailer video URL for the channel

priceType: Int

Price of the channel content

titleType: String

A channel title realated to the channel language

subtitleType: String

A channel subtitle related to the channel language

htmlDescriptionType: String

An osteocom html description that describe the channel.

videoType: Array

videoIdType: String

Unique identifier for the video

backgroundType: String

Background image URL for the video

coverType: String

Cover image URL for the video

trailerType: String

mp4 trailer for the video

authorsType: Array

Contains references to the authors, specifically the name and image if anyfor each author

nameType: String

Author's name

imageType: String

Author's image URL

titleType: String

A video title realated to the channel language

subtitleType: String

A video subtitle related to the channel language

htmlDescriptionType: String

An osteocom html description that describe the video.

durationType: Int

duration of a video in seconds

videoQualityType: Int

the quality of the video: i.e. FULLHD

audioType: Array

nameType: String

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 the content chosen and its price). After processing this data, the user is authorized to access purchased content.
<>

Header

AuthorizationType: String

Bearer token mandatory

Payload

clientIdType: String

Unique identifier for the client.

emailType: String

User's email address.

nameType: String

User's name.

surnameType: String

User's surname.

marketingMailType: String

Specifies whether the user has agreed to marketing consent.

productsType: Array of Objects

Products is an array containing objects. Each object represents a products with the associated price.

priceType: Int

Specifies the price of that product.

productIdType: String

The channelId used for identify the channel purchased by the customer. This field is mandatory passed to osteocom requests when required.

Response

tokenType: String

A token for accessing purchased content.

HTTP Status Codes

Status Code	Description
`200 OK`	Purchase successful.
`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 outocome is a token that you can use by embedding into our provided url within an iframe; see the section: Iframe-Based Video Access.
<>

Header

AuthorizationType: String

Bearer token mandatory

Payload

clientIdType: String

The partner's unique client ID

videoIdType: String

Unique identifier for the video

userAccessKeyType: String

Access key that authenticates the user

Response

tokenAuthVideoType: String

A token that must be used as parameter into a dedicated url.

HTTP Status Codes

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