Getting started

Introduction

This API allows you to fetch multiple resources. To see available resources, refer to the API section of the documentation.

The API base URL is https://api.mediafilm.ca

This documentation assumes that, if you're using this API in an application, API requests are made from a server. You should not make them from the client side.

To use this API, you need to have:

  • An active Mediafilm account
  • An active API key

You can generate an API key from the account page.

The API is based on the Directus API. You can refer to their documentation for details about the query parameters.

Making API requests

You will have to authenticate your API requests to receive a successful response from the server. To do that, you'll have to set two headers in your api request:

  • An "api-key" header containing your API key
  • A "X-Session-Token" header containing a valid session token

Generating a session token

Authentication is based on ory. You can use ory's sdk in the language of your choice to make generating a session token easier.

The base URL for kratos is https://ids-pub.panoscope.ca

The steps to create generate a session token are to:

  1. Create a login flow for native apps
  2. Complete the login flow using your mediafilm credentials

If you complete the login flow successfully, the server should return you a valid session token.

You can find a example of how to implement this in a vue application here.