OvercastHQ Connector v1.0
1. General Information
OvercastHQ is a cloud-based video asset management platform designed to help teams, especially dispersed or remote, manage, edit, and collaborate on video content more efficiently.
Login to OvercastHQ using the correct credentials. After logging in we will be directed to the below homepage.
2. Authentication
Overcast APIs are authenticated using API-Keys.
Creating API Key
We use the endpoint POST to create the API Key. For first time we will be needed to get the Bearer token using chrome’s dev tools for authentication of the endpoint Create API Key. Bearer token will be used in authorization for creation of the API-Key.
Listing API Keys
We use the endpoint Get to retrieve the list of API Keys and use in header x-api-key of subsequent requests for authentication.
3. Connector Actions and Tests
Default: List Assets (GET)
Action Name / Method | Default: List Assets (GET) |
|---|---|
Action Description | This action is used to list all assets in OvercastHQ. |
Test Case | This action is used to create task. |
Request Body Name | Parameter |
4. Connection Settings and Configuration
Settings Parameters | Value | Description | Required (Y/N) | Default Value |
|---|
Settings Parameters | Value | Description | Required (Y/N) | Default Value |
|---|---|---|---|---|
Connector | OvercastHQ | Connector Name | Y | OvercastHQ |
Host Name | Endpoint required for performing CRUD | Y | ||
Authentication | ApiKey | Type of authentication | Y |
|
Api Key | {apiKey} | Api Key Value | Y |
|
