MediaValet Connector v1.0
1. Prerequisites and Additional Steps, Developer Key
Log into MediaValet Portal with the correct credentials for Asset Management.
After login user will be redirected to the dashboard page.
For OAuth connectivity, login to the MediaValet Support Portal and send a request to register your callback URL. Example OAuth callback URLs are:
https://<domain>/rest/v1/oauth2/callback
2. Connector Action & Tests
Action Name / Method | Retrieve Categories | Local Tests | Dev Tests | Q/A Tests |
|---|---|---|---|---|
Action Description | Returns list of categories for the library |
|
|
|
Test Case | Retrieve Categories | Pass | Pass |
|
Action Name / Method | Request Upload URL | ||
|---|---|---|---|
Action Description | Creates an asset and returns newly created asset information | ||
Test Case | Request Upload URL | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
Options | Filename | String | studio.jpg |
Action Name / Method | Upload Binary File | ||
|---|---|---|---|
Action Description | Upload binary file to Mediavalet to its provided upload url, which we can get from the Request Upload action. This action is added using the HTTP Rest connector. | ||
Test Case | Upload binary file | ||
Request Body Name | Parameter | Type | Description (Example) |
| Method Name | String | put |
| Http Operation | String | https |
| Consumes Format | String | application/json |
Headers | Header Key | String | x-ms-blob-type |
Headers | Header Value | String | BlockBlob |
| Request Body Type | String | binary |
| Binary Data Path | String | File path can be specified here for upload. File download method is explained under section “How to download binary file“ |
| Full URI | String | Upload URL, coming from Upload request action response |
Action Name / Method | Add Title/Description/FileSize | ||
|---|---|---|---|
Action Description | Add asset properties with values | ||
Test Case | Add Title/Description/FileSize | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
Options | Description | String | Asset description |
Options | Title | String | Asset title |
Options | Filename | String | File name |
Options | Filesizeinbytes | Long | File size in bytes to upload |
Action Name / Method | Assign Asset to the Category | ||
|---|---|---|---|
Action Description | Asset a category to the asset | ||
Test Case | Assign Asset to the Category | ||
Request Body Name | Parameter | Type | Description (Example) |
Options | Category id | String | User can get category id using the Retrieve Categories action. Details provided under “Retrieve Categories action“ |
Action Name / Method | Finalize Upload | ||
|---|---|---|---|
Action Description | Update asset with a list of patch operations | ||
Test Case | Finalize Upload | ||
Request Body Name | Parameter | Type | Description (Example) |
| AssetId | String | urn:uuid:bb93be4f-89d6-0086-e619-8d52e3ee08ce (Required) The asset id. Detail given in “How to get Asset/Object Id“ part. |
Options | Op | String | replace |
Options | Path | String | /status |
Options | Value | String | 1 |
Action Name / Method | Checkout Asset | ||
|---|---|---|---|
Action Description | ChecksOut an asset and returns the current blob URL. | ||
Test Case | Asset checkout | ||
Request Body Name | Parameter | Type | Description (Example) |
| AssetId | String | urn:uuid:bb93be4f-1234-1234-e456-8d52e3ee08ce (Required) The asset Id. Detail given in “How to get Asset/Object Id“ part. |
Action Name / Method | Validate Asset Checkin | ||
|---|---|---|---|
Action Description | Validate asset check-in filename | ||
Test Case | Validate asset checkin | ||
Request Body Name | Parameter | Type | Description (Example) |
| Id | String | (Required) The asset Id. Detail given in “How to get Asset/Object Id“ part. |
Options | Options | String | Resource file name |
How to download binary files:
To initiate the mediavalet file upload request, we first need to download the required file on OneTeg platform using any downloader. In the picture below we are using the Swagger standard downloader. After downloading, the user can see the file path in the output section. This output variable can be used later with any step where we need to upload the file.
How to get Asset/Object Id:
Go to the Mediavalet dashboard and click on the asset detailed information button:
You can see all the asset attributes and values on the detailed page. Asset/Object id is available in the list:
3- Connection Settings and Configuration
Settings Parameters | Value | Description | Required (Y/N) | Default Value |
|---|---|---|---|---|
Connector | MediaValet | MediaValet connector | Y | MediaValet |
clientId | 039xxxx-xxxx-xxxx-xxxx-24d4bexxxxx |
| Y | 039xxxx-xxxx-xxxx-xxxx-24d4bexxxxx |
clientSecret | gqVS2uHmwfZFxxxxxxxxxxxxzxxxxx= |
|
| gqVS2uHmwfZFxxxxxxxxxxxxzxxxxx= |
Authorization Url | Endpoint required for performing CRUD | Y | ||
Token Url |
|
| ||
Scopes | "openid", "api", "offline_access" |
|
|
|
