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 |