Table of Contents
Application Programming Interface (API)
Video Player Public API
Summary
The following public API’s/routes are available for use by other users and services, without authentication.
API List
Purpose | HTTP Method(s) | Route | Response (Success/Fail) |
Video Player IFRAME |
|
| HTML/HTML |
Video Player Embed JavaScript |
|
| JavaScript/HTML |
Video Player Thumbnails |
|
| JSON/JSON |
URL Construction
The root address is:
An example, using the thumbnail API is, in generalized form:
|
An example, using the thumbnail API with a specific ID:
https://player.pitchhub.com/en/public/player/thumbnails/2da754b668b50840e5d76f3a37f488a2 |
API details
Video Player IFRAME
Video player designed to be used inside of an IFRAME, so there are no context controls.
Request
Relative Route
/public/player/iframe/{id}
Route Parameters
ID | Required | Description |
| Yes | Video Menu token or Video token, also referred to as "id" in the PitchHub Video Export screen. |
Response
Response
Valid (200)
Example:
|
Not Found (404)
Example:
|
Video Player Embedded
Video player designed to be imported in a <script> tag, as JavaScript code.
Request
Relative Route
/public/player/embed/{id}
Route Parameters
ID | Required | Description |
| Yes | Video Menu token or Video token, also referred to as "id" in the PitchHub Video Export screen. |
Response
Valid (200)
Example:
|
Not Found (404)
Example:
|
Video Player Thumbnails
Return a JSON object with an array of available thumbnails.
The number of thumbnails in the array will vary depending upon the full size dimensions. The pixel width and height of each thumbnail is listed, along with the full URL to the thumbnail.
In the future:
- Thumbnails can originate from other services (AWS S3/CloudFront, Mux.com, etc.)
- Thumbnails might have signed URL’s that represent an extremely long amount of time.
Request
Relative Route
/public/player/thumbnails/{id}
Route Parameters
ID | Required | Description |
| Yes | Video Menu token or Video token, also referred to as "id" in the PitchHub Video Export screen. |
Response
Valid (200)
Example:
https://player.pitchhub.com/en/public/player/thumbnails/2da754b668b50840e5d76f3a37f488a2 |
Result
|
Not Found (404)
Example:
|
