API documentation

Prev Next

Frisbii Media is based on the API-first principle. All functions can be found in the Frisbii Media API documentation:

Stage API documentation for Stage System: Frisbii Media API v3

Public API documentation for live system: Frisbii Media API v3

Note: As soon as we make changes to the Frisbii Media API - be it bug fixes, improvements or new features - the API documentation is updated at the same time to provide up-to-date information.  

The Frisbii Media API uses the following authentication:

Security Scheme Type: API Key

Header Parameter Name: X-plenigo-token

Access rights are required to execute the corresponding endpoints, which must be defined in the Merchant Backend when the API access token is created. Which access rights are required can be found in each chapter of the API documentation.

The required API tokens can be created, maintained and copied in the Merchant Backend in the respective client.>> API access token

Requests

The HTTP methods (e.g. GET and POST) determine the type of operation on the resource. Query parameters can be used to provide additional options for the GET requests. POST parameters provide the data for write operations such as creation, modification of the resource(s).

Status codes

The following status codes are used in the Frisbii Media API:

  • Code 2xx - indicate a successful call.

  • Codes 4xx - indicate a client-side problem with the call. 

  • Codes 5xx - indicate a server-side problem with the call. 

Responses

The response from the API is in JSON format. Currently, the Frisbii Media API does not support any other response format.