Inriver Connector v1.0
1. Prerequisites and Additional Steps, Developer Key
Log into InRiver Portal with the correct credentials for Digital Asset Management.
To access assets, please click on the “Your Content” welcome picture when you log in to the InRiver site.
Products are listed here:
Enter InRiver admin panel:
API key management can be accessed from User Management link:
Click on any API Key you want to preview.
2. Connector Action & Tests
Action Name / Method | Search for entity id’s | ||
|---|---|---|---|
Action Description | If you want to find a specific entity for example Product, Item | ||
Test Case | Search entity using different filters | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
DataCriteria | Fieldtypeid | String | For example ItemId, ProductId |
DataCriteria | Value | String | For example Item id: PLF3030-MB |
DataCriteria | Operator | String | String: Equal, NotEqual, BeginsWith, IsEmpty, IsNotEmpty, Contains File: Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, IsEmpty IsNotEmpty, Language LocaleString: Equal, NotEqual, BeginsWith, IsEmpty, IsNotEmpty, Contains |
Action Name / Method | Add Media From Url | ||
|---|---|---|---|
Action Description | If you want to find a specific entity for example Product, Item | ||
Test Case | Search entity using different filters | ||
Request Body Name | Parameter | Type | Description (Example) |
| Entityid | String | Entity id for example, any product/item id |
Options | Url | String | |
Options | Overrideurlfilename | String | test_image.jpg |
Action Name / Method | Create a new Entity | ||
|---|---|---|---|
Action Description | Create a new entity for example Product, Item | ||
Test Case |
| ||
Request Body Name | Parameter | Type | Description (Example) |
Options | Entitytypeid | String | Product, Item |
Options | Segmentid | String |
|
FieldValues | Fieldtypeid | String | ProductId |
FieldValues | Value | String | test-product |
Action Name / Method | Add Media Upload Base64 | ||
|---|---|---|---|
Action Description | This action is used to upload file binary data for any product/item media part | ||
Test Case |
| ||
Request Body Name | Parameter | Type | Description (Example) |
| Entityid | String | Entity id for example of Product/Item |
Options | Filename | String | test-asset.jpg |
Options | Data | String | ProductId |
To find which Entities are being worked on the Inriver system; an easy way of navigation is selecting any product on the Enrich page and changing the URL to the new Entityid
https://portal2-xxx/8918
8918 is the Entityid. Changing the value will navigate you to the new product. You can also check the ID of the entity from the Overview panel System info button:
Action Name / Method | Search Products After Last Run | ||
|---|---|---|---|
Action Description | Search products after last run date | ||
Test Case |
| ||
Request Body Name | Parameter | Type | Description (Example) |
Value |
| String | Date and time, getting from excel stored in flow last run |
Type |
| String | InRiver field, to compare with value e.g. LastModified |
Operator |
| String | Comparison operator e.g Equal, GreaterThanOrEqual |
3. Connection Settings and Configuration
