{"info":{"_postman_id":"cfe90008-575a-4f16-9220-6cc2f6a878ec","name":"Mediaflow 3.0 Customer API Docs","description":"

Mediaflow API is a REST API based on JSON data over HTTPS. All calls and answers must be in UTF-8. Calls with POST or PUT must have the HTTP header Content-Type: application/json. Note that the numeric ID can also be negative. All calls require authentication with OAuth2, where an access token can be sent with either in the URL as the query parameter access_token, e.g

\n
GET /1/folders?access_token=igfragagsnckagnkgadciangdsnjg HTTP/1.1
Host: api.mediaflow.com
\n

or the access token can be sent via the HTTP header Authorization

\n
GET /1/folders HTTP/1.1
Host: api.mediaflow.com
Authorization: Bearer igfragagsnckagnkgadciangdsnjg
\n

The format and length of an access token may vary.

All answers from the API on GET calls comes with a JSON array as the root object, even if the answer contains only one object. The exception is for errors (when an error object is returned), and for OAuth2 authentication. If it is an empty result, an empty array is returned [].

Fields

By default, only a few selected fields are included for each endpoint. To specify exactly which fields you are interested in, send a comma-separated list with the query string parameter fields. The field names must be written in lower case letters.

\n
For example:
https://api.mediaflow.com/1/folder?fields=id,name,parents
\n

By entering fields=any you get all available fields. Avoid using fields=any in production (only include the fields you are interested in). Note that new fields may be added to the API over time. The field id is always returned and cannot be deselected.

Page division

By default, all entries are returned. If you want to limit the number of entries, you can use the query string parameters page and per_page.

If the page parameter is used, the total number of entries in the HTTP header X-Total-Count is returned.

\n
For example:
https://api.mediaflow.com/1/folder?page=1&per_page=20
\n

CORS

The API fully supports CORS calls via the HTTP header Access-Control-Allow-Origin, even for OPTIONS calls. If necessary, all specified HTTP headers are also listed via Access-Control-Expose-Headers.

OPTIONS calls always return status 204 No Content and no content.

JSONP

For all GET calls, it is also possible to get JSONP-adapted answers. Note that with JSONP, errors are always returned with HTTP status code 200, and the correct error code is included in the error object. Enter the function name with the query string parameter callback.

\n
For example:
https://api.mediaflow.com/1/folder?callback=parseResponse
\n

Error handling

All errors are returned with a corresponding HTTP status code and a JSON error object.

\n
For example:
400 Bad Request
{
\"status\": 400,
\"error\": \"Invalid JSON data\"
}
\n

Authentication

OAuth2

Authentication uses OAuth2 to the URL https://api.mediaflow.com/1/oauth2/token where the following grant_type is supported:

\n
grant_type=password
grant_type=refresh_token
grant_type=authorization_code
\n

All authentication calls require that you enter a client_id and a client_secret.

Grant Type: refresh_token

If you have previously received a refresh_token it can be used to get a new valid access_token even if the previous access_token has expired.

This is also used in the case of having and integration key or server key__, those keys are refresh tokens and should be used by the same flow.

Parameters for calls

\n
grant_type \"refresh_token\"
client_id identifier for the API client
client_secret Password for the API client
refresh_token a refresh token from a previous call
\n

Upon successful authentication, the response contains:

\n
access_token access_token used for all API calls
token_type always \"Bearer\"
expires_in how long, in seconds, the specified access_token is valid
\n

The value of expires_in depends on the client_id used for the authentication.

Grant Type: authorization_code

To authenticate with grant_type=authorization_code always use the URL https://login.mediaflowpro.com/authorize with the following query string parameters:

\n
response_type should always be \"code\"
client_id identifier for the API client
redirect_uri which URL the user should be sent to after authentication
state optional data sent back after the call (not mandatory)
\n

Thereafter another call is made to https://api.mediaflow.com/1/oauth2/token with grant_type=authorization_code.

Grant Type: password

Note that not all _client_id_ allow login with the _grant_type=password_ type.

Enter the following parameters for calls

\n
grant_type should always be password
client_id identifier for the API client
client_secret password for the API client
username username
password password
state optional data sent back after the call (optional)
\n

Upon successful authentication, the response contains:

\n
access_token access_token used for all API calls
refresh_token token to renew an access_token when it expires
token_type always \"Bearer\"
expires_in how long, in seconds, the specified access_token is valid
state the same data as in the call. Only if it was indicated at the call
\n

The value of expires_in, and whether a refresh_token is returned or not, depends on the client_id used for the authentication.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23189985","collectionId":"cfe90008-575a-4f16-9220-6cc2f6a878ec","publishedId":"2s8YzL4meR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-12-02T11:02:05.000Z"},"item":[{"name":"Folder","item":[{"name":"Get folder tree","id":"b4bf7e07-3847-4894-b152-f00da7b44c07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.mediaflow.com/1/foldertree?archived=true&private=true&shared=true","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"cfe90008-575a-4f16-9220-6cc2f6a878ec","id":"cfe90008-575a-4f16-9220-6cc2f6a878ec","name":"Mediaflow 3.0 Customer API Docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","foldertree"],"host":["api","mediaflow","com"],"query":[{"description":{"content":"