Akeneo Connector v1.0
1. Prerequisites and Additional Steps
Log into the Akeneo Portal with the correct credentials for Product Information Management.
Products and assets are listed here:
2. Authentication.
To access the REST API, you will need to be authenticated. To authenticate http requests Akeneo supports oath2. We would need Client ID, Secret, Username and Password.
Creating Connection
To get the above mentioned credentials we need to create a Connection. To create a new connection go to Connect tab and in Connection Settings on the top right corner click the Create button.
Choose Data Source if connection is to used to get production information from Akeneo using the connection or select Data Destination if connection is to used to update product information on Akeneo PIM.
From the newly created connection we can get the credential to be used in connection like Client ID, Secret, Username and Password.
3. Event Subscription / Webhook
For webhook / event subscription settings, go to the following page to create new rules:
4. Connector Action & Tests
Action Name / Method | Search Product | ||
|---|---|---|---|
Action Description | Search products/assets using different filters | ||
Test Case | Search products using different filters | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
| Page | String | No of pages to fetch |
| Search | String | Search text for filtering |
| Limit | String | No of records per page to fetch |
Action Name / Method | Create Asset | ||
|---|---|---|---|
Action Description | Create new asset on PIM | ||
Test Case | Create new asset on PIM | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
| Label | String | Asset label |
| Media Link | String | Asset media link for attaching files e.g images |
Action Name / Method | Delete Asset | ||
|---|---|---|---|
Action Description | Delete an existing asset | ||
Test Case | Delete Asset | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
| Code | String | Asset code e.g test_product729 |
| Asset Family Code | String | Asset family code e.g productimages |
Action Name / Method | Get Product | ||
|---|---|---|---|
Action Description | Get product data | ||
Test Case | Get product data | ||
Request Body Name | Parameter | Type | Description (Example) |
|
|
| |
| UUID | String | Product unique identifier |
5. Connection Settings and Configuration
Settings Parameters | Value | Description | Required (Y/N) | Default Value |
|---|---|---|---|---|
Connector | Akeneo | Connector Name | Y | Akeneo |
Token |
| Token required for API authentication purposes ( Check 1. Prerequisites and Additional Steps, Developer Key for Token ) | Y |
|
Endpoint | Endpoint required for performing CRUD | Y | ||
Token URL | OAuth token data field | Y |
| |
Client ID | 2234**23423423423 | OAuth client id | Y |
|
Client secret | 2234/0082938423 | OAuth client secret | Y |
|
Scopes |
| Define access required for that connector | Y |
|
