Introduction

To use the TranscribeMe API, you must request an API key to use in all API requests.
You can request an API key on this form.
The API key should be passed in the API calls as a custom header called "X-Api-Key".

Authentication

API authentication is achieved via a bearer token which identifies a single user.
Access token should be passed in the API calls as an authorization header parameter called "Bearer" (like 'Bearer [YOUR TOKEN]').
In order to get an access token some additional data must be sent in the request:

client_id (X-Api-Key) - this is provided by TranscribeMe

client_secret - this is provided by TranscribeMe

username - Username (email) of the portal account

password or applicationtoken

For the first-time login uder particular account you should use password and grant_type=password.

After that you will be able to generate applicationtoken and use it for authentication in the future.
There are couple of reasons why applicationtoken usage is more preferable than password for API Integration:

Password can be changed on UI and as a result all api calls authorization will fail

Passwords have policies and it is required to change password periodically

Applicationtoken can be regenerated using regenerate method.
Here is the sample of getting Access token using applicationtoken:

Error Details

The API uses two different formats to describe an error.

Authentication error object

When the application makes requests to the API related to authentication or authorization (e.g. retrieving an access token or refreshing an access token) the error response follows RFC 6749 on The OAuth 2.0 Authorization Framework. Below is an example of a failing request to refresh an access token.

Regular error object

Apart from the response code, unsuccessful responses return information about the error as an error JSON object containing the StatusCode and the array of error messages. Here is an example error response: