Resources · Changelog

API Documentation (1.0.0)

Version1.1.11.1.01.0.0

Following this section, goes to privide all description fields of api's.

Base URL

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.

Authorization API POST

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.

POST/contentLicensing_login

Payload

clientId

String

The partner's unique client ID

clientSecret

String

The secret key associated with the client ID

Response

token

String

The generated JWT token

HTTP Status Codes

Status Code	Description
200 OK	A valid JWT token.
401 Not Authorized	Unknown client

---

Catalog API: Content catalog access POST

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.

POST/contentLicensing_catalog

Header

Authorization

String

Bearer token

Payload

clientId

String

The partner's unique client ID

Response

catalog

Array of Objects

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

catalog[] object

idChannelString

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.

authorsArray

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

backgroundString

Background image URL for the channel

coverString

Cover image URL for the channel

trailerString

Trailer video URL for the channel

priceInt

Price of the channel content

titleString

A channel title realated to the channel language

subtitleString

A channel subtitle related to the channel language

htmlDescriptionString

An osteocom html description that describe the channel.

videoArray

catalog[].authors[] object

nameString

Author's name

imageString

Author's image URL

catalog[].video[] object

videoIdString

Unique identifier for the video

backgroundString

Background image URL for the video

coverString

Cover image URL for the video

trailerString

mp4 trailer for the video

authorsArray

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

titleString

A video title realated to the channel language

subtitleString

A video subtitle related to the channel language

htmlDescriptionString

An osteocom html description that describe the video.

durationInt

duration of a video in seconds

videoQualityInt

the quality of the video: i.e. FULLHD

audioArray

catalog[].video[].authors[] object

nameString

Author's name

imageString

Author's image URL

catalog[].video[].audio[] object

nameString

the language of the audio translation: i.e. italian or english

HTTP Status Codes

Status Code	Description
200 OK	Catalog is returned
404 Not Found	Catalog not found
500 Internal Server Error	Unexpected error

---

Content Access Authorization POST

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.

POST/contentLicensing_contentAccessAuthorization

Header

Authorization

String

Bearer token mandatory

Payload

clientId

String

Unique identifier for the client.

email

String

User's email address.

name

String

User's name.

surname

String

User's surname.

marketingMail

String

Specifies whether the user has agreed to marketing consent.

products

Array of Objects

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

products[] object

priceInt

Specifies the price of that product.

productIdString

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

Response

token

String

A token for accessing purchased content.

HTTP Status Codes

Status Code	Description
200 OK	Purchase successful.
500 Internal Server Error	Unexpected error.

---

Video API POST

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.

POST/contentLicensing_videoAccess

Header

Authorization

String

Bearer token mandatory

Payload

clientId

String

The partner's unique client ID

videoId

String

Unique identifier for the video

userAccessKey

String

Access key that authenticates the user

Response

tokenAuthVideo

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