Download OpenAPI specification:Download
Production endpoint: https://gsc-api-prp.fcst.tv/api
Username:
Password: Contact support
Our API is based on the JSON:API 1.0 specifications. So you MUST include the Content-Type: application/vnd.api+json
and the Accept: application/vnd.api+json
HTTP header in all your API calls.
Most calls require a valid authentication with a bearer access token. We use OAuth 2.0 for the authentication process (via the /login
endpoint).
Here's a small example of a successful authentication to our API:
First, get an authorization token:
POST /api/login HTTP/1.0
Host: gsc-api-prp.fcst.tv
Content-Type: application/vnd.api+json
{
"username": "johndoe@example.com",
"password": "123456"
}
HTTP/1.0 200 OK
Content-Type: application/vnd.api+json
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImZhYzE5ZWU5YWZjZTE0NTE5ZjYxYzlmM2U4YTg1MmY3ZGY5ZjNkMjllMmYzNDVkZmNhYThmNjc5NGVkNWU5NDgzNWE1MDQwYTYzYzJkYjJmIn0",
"data": {
"type": "user",
"id": "8f902e00-f427-4405-903b-e06c62cd46cc",
"attributes": {
"name": "John Doe",
"email": "johndoe@example.com",
"firstname": "John",
"lastname": "Doe"
}
}
}
You must use the access_token
in upcoming calls (in the Authorization
HTTP header).
Pre-production server
username required | string This field can be either your username or your email address. |
password required | string |
Return an acces token and the logged user data.
access_token | string |
data | object |
Unauthorized
errors | Array of objects |
Pre-production server
No Content
Unauthorized
errors | Array of objects |
Pre-production server
Return the authenticated user data.
data | Array of objects |
Unauthorized
errors | Array of objects |
Pre-production server
Accept-Language | string Specify the local language you want to get. E.g.:
|
Return an array of users data.
data | Array of objects |
links | object |
meta | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
A JSON object with user information.
data required | object |
password_confirmation required | string |
The new user has been created.
data | Array of objects |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
Return the requested user data.
data | Array of objects |
links | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
A JSON object with user information.
data required | object |
password_confirmation required | string |
The requested user has been updated.
data | Array of objects |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
Accepted
No Content
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
filter | Array of any Items Value: "filter[...]=..." Filter the results by one or many (separate by a comma) content attribute(s).
You can also use wildcard (
Additional filters:
|
sort | Array of any Items Value: "sort[...]=..." Sort the results by one or more attributes. By default the sort is ascending. For descending sort, pre-pend the attribute name by an hyphen. You can also combine multiple attributes for more complex sorting. E.g.:
Additional sorting options:
|
include | Array of any Items Value: "include=..." Include one or more relation into the query content results. E.g.:
|
page | Array of any Items Value: "page[...]=..." Results pagination E.g.:
|
Accept-Language | string Specify the local language you want to get. E.g.:
|
Return an array of events data.
data | Array of objects |
links | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
Creates a live video and schedule its publication and live start date-time. Behind the scenes, the live stream is configured on live-origin server. Ready to use embed codes are returned by the API, as well RTMP stream to be used for social network shares.
A JSON object with event information.
data required | object |
The new event has been created.
data | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
Returns main information related to a live event based on its unique identifier(UUID). Information includes publication status, start/end date-time for live stream diffusion as well embed code to be used to integrate the player on a web site.
uuid required | string The content UUID |
include | Array of any Items Value: "include=..." Include one or more relation into the query content results. E.g.:
|
Accept-Language | string Specify the local language you want to get. E.g.:
|
Return the requested event data.
data | object |
links | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
Allows to change main information related to a live event. Start and stop date-time allows to instantly display/hide holding image to hide/reveal the live stream in the player. Duration is automatically calculated.
uuid required | string The content UUID |
Content-Language | string Specify the local language you want to update. E.g.:
|
A JSON object with event information.
data required | object |
The requested event has been updated.
data | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
The requested event has been deleted.
meta | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
Start the requested event.
data | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
A JSON object with event display information.
data required | object |
Stop the requested event.
data | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
Set a video posterframe can be used in three ways to define the still image to be used for a video: by uploading a custom image from a file or from an URL or by extracting an image from a video at selected time. The API returns an absolute URL for generated posterframe.
uuid required | string The content UUID |
Image file as JPEG or PNG
The new poster has been created.
data | Array of objects |
links | object |
meta | object |
No Content
Bad Request
errors | Array of objects |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
Accepted
No Content
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
A JSON object with clip information.
There are two payload possible:
(Click on 'object' button hereunder to switch between payload)
data required | object |
The job has been created.
data | object |
No Content
Bad Request
errors | Array of objects |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
A JSON object with player configuration information.
data required | object |
The video player configuration have been updated.
data | object |
meta | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
Return an array of chapters data.
data | Array of objects |
links | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
A JSON object with chapter information.
data required | object |
The new chapter has been created.
data | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
id required | string or string The chaper uuid or legacy_id |
Return the requested chapter data.
data | object |
links | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
id required | string or string The chaper uuid or legacy_id |
A JSON object with chapter information.
data required | object |
The requested chapter has been updated.
data | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
id required | string or string The chaper uuid or legacy_id |
The requested chapter has been deleted.
meta | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
Include relation for event display is: background
.
uuid required | string The content UUID |
include | Array of any Items Value: "include=..." Include one or more relation into the query content results. E.g.:
|
Return the requested event display data.
data | Array of objects |
meta | object |
links | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
A JSON object with event display information.
data required | object |
The new event display has been created.
data | Array of objects |
meta | object |
links | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
The requested event display has been deleted.
meta | object |
Accepted
No Content
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
Return an array of jobs data.
data | Array of objects |
links | object |
meta | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
Return the requested job data.
data | object |
links | object |
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
uuid required | string The content UUID |
Accepted
No Content
Unauthorized
errors | Array of objects |
Not Found
errors | Array of objects |
Pre-production server
A JSON object with mercure information.
data required | object |
Notification created.
Accepted
No Content
Unauthorized
errors | Array of objects |
Forbidden
errors | Array of objects |
Not Found
errors | Array of objects |
Conflict
errors | Array of objects |
Pre-production server
Return the current version of the Freecaster API.
version | string |