How to use the MX Film API

For termanology and some additional context please check out our MX concepts article

The MX Film API is a restful api that allows you to perform some of the following actions:

  • find a release using its title
  • get a list of releases that have been updated during a time frame
  • get media items for a release

In general you will need to follow the steps below when making requests to the api

  1. Get an Authentication token
  2. Store your token to be used in subsequent requests
  3. Make your request and read the response
  4. Process the response and make any subsequent requests
  5. Renew your Authentication token when it expires.

For some some common use cases see our Common workflows article

Authentication

Getting Credentials

  1. Request credentials by contacting us at **[email protected]**

    Note: We strongly recommend that you request user credentials for your application rather than a real person.

  2. When you receive the user-account confirmation email, click on the link to verify your username and set a password.

  3. After the provisioning process for your account has been completed, you will receive a second email containing your client ID.

Authentication

Requests to the MXF API requires that an authentication token accompanies the request. The authentication token can be retrieved by using the credentials mentioned in the Getting Credentials section and making a call to the Authentication API endpoint.

The call will need to be a POST request to the endpoint described on the Introduction page.

Required Headers

Content-Type: application/x-www-form-urlencode

Request Body

username=[your_username]&password=[your_password]&grant_type=password&client_id=[your_client_id]

If the request is successful, the resulting token needs to be included in all subsequent requests in the Authorization header as a Bearer token