Getting started

Presentation

API URL

This API exposes all the metadata present in our database. It has been designed to meet the main needs of our customers. 

Use of this API is reserved only for our customers.

Each customer has a login/password to access the developer portal

Access to the various API methods and metadata varies according to the rights assigned to an account.

This is a REST API. Responses are in JSON with UTF-8 encoding.

Getting started

Your user account gives you access to the developer portal, where you can retrieve your authentication token, test the different methods and consult your statistics.

Token recovery

The token can be accessed via the “Profile” option in the menu.

2 tokens are available. We recommend using the primary token.

If your token is compromised, you can request that it be regenerated.

Using the API

				
					Standard HTTP request to call a method.
Example implementations are available for different languages on each method page.
GET https://api.plurimedia.fr/v1/api/v1/contents/7488 HTTP/1.1
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: ••••••••••••••••••••••••••••••••
Standard answer
HTTP response
HTTP/1.1 200 OK

cache-control: no-cache
content-encoding: gzip
content-length: 2006
content-type: application/json; charset=utf-8
date: Tue, 05 Nov 2024 11:25:51 GMT
expires: -1
pragma: no-cache
request-context: appId=cid-v1:573995c4-a10b-48e5-b5b5-78ad0699dd05
vary: Accept-Encoding,Origin
x-aspnet-version: 4.0.30319
x-powered-by: ASP.NET

{
    "version": "v1",
    "statusCode": 200,
    "data": {
        "id": 7488,
        "title": "Blade Runner",
        "typographicTitle": "Blade Runner",
…
"lastUpdate": "2024-09-27T07:48:30.677",
        "isFre": true
    }
}


Note: Calls with no result return code 200 with an empty JSON.
				
			

Testing an endpoint

Each endpoint can be tested. The endpoints are accessible via the APIS option in the menu bar. This option lets you choose an API version, then displays all the endpoints available for the selected version. 

For each endpoint, a Try it button allows you to test it.

To test a method, simply fill in the mandatory parameters and launch the request using the Send button. Optional parameters are identified by the Remove parameter option.

Note that the lang parameter is always optional.

 

Data organization

A content centric database

The main entity: the contents. Each content has at least :

  • A unique ID
  • A title
  • A format
  • A genre

There are 16 formats (Film, Series, Documentary, Sports Show, Magagazine…). The full list of formats and genres is available via the Endpoint: Categories

The diagram below summarizes the information potentially available for a content.

 

View statistics

Statistics can be accessed via the Reports option in menu.