API Authentication

The Caption.Ed uses OAuth 2.0 for authentication. We support the following grant types:

• Assertion (with the provider dashboard)

• Refresh Token

The API is private and you must have a client ID, secret and assertion token to consume it.

You can read more about OAuth 2.0 and it's associated grant types at https://oauth.net/2/.

Authenticate via Assertion Grant type

POST https://api.captioned.carescribe.io/oauth/token

Query Parameters

Name	Type	Description
grant_type	string	Must be assertion
provider	string	Must be dashboard
assertion	string	Your assertion token
client_id	string	Your application client ID
client_secret	string	Your application client secret
scope	string	Must be write_transcriptions write_media

200 Successfully authenticated

{
  "access_token": "<secret>",
  "token_type": "Bearer",
  "expires_in": 7200,
  "refresh_token": "<secret>",
  "scope": "write_transcriptions write_media",
  "created_at": 1619529327
}

Authenticate via Refresh Token

POST https://api.captioned.carescribe.io/oauth/token

Query Parameters

Name	Type	Description
grant_type	string	Must be refresh_token
refresh_token	string	Your refresh token
client_id	string	Your application client ID
client_secret	string	Your application client secret

200

{
  "access_token": "<secret>",
  "token_type": "Bearer",
  "expires_in": 7200,
  "refresh_token": "<secret>",
  "scope": "write_transcriptions write_media",
  "created_at": 1619529327
}

Authenticating with the API

Every call you make to the Caption.Ed API must include the following two headers:

Header Name	Header Value
Accept	application/vnd.captioned.v1
Authorization	Bearer <access token>

Replace <access token> with the access token that was provided to you when authenticating in the above steps.