Extensions and integrations
Base URL: https://api.amplience.net/v2/content
Authorization and status codes
For authorization and status codes see the API Reference overview.
ExtensionsLink copied!
| Method | Endpoint | Summary |
|---|---|---|
GET | /extensions/{id} | Get extension |
PATCH | /extensions/{id} | Patch extension |
DELETE | /extensions/{id} | Delete extension |
GET | /hubs/{hubId}/extensions | List extensions |
POST | /hubs/{hubId}/extensions | Create extension |
GET | /hubs/{hubId}/extensions/{name} | Get extension by name |
Get extensionLink copied!
GET /extensions/{id}
https://api.amplience.net/v2/content/extensions/{id}
Return the extension with the specified ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
extensionId | path | string | ✓ | Extension ID Example: 00112233445566778899aabb |
Responses
| Status | Description |
|---|---|
| 200 | Extension Response |
Response Example (200)
Patch extensionLink copied!
PATCH /extensions/{id}
https://api.amplience.net/v2/content/extensions/{id}
Patch an Extension
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
extensionId | path | string | ✓ | Extension ID Example: 00112233445566778899aabb |
Request Body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | ✓ | System name |
label | string | ✓ | User friendly name |
description | string | Description | |
url | string | ✓ | Url |
height | integer | Height of the extension | |
enabledForAllContentTypes | boolean | Sets whether the extension is globally enabled or intended for a specific content type | |
category | string (CONTENT_FIELD) | ✓ | Type of extension |
parameters | array | Array of config parameters | |
snippets | array | Array of snippets | |
settings | string | The settings parameter is used to store undefined extension settings such as security rule. |
Request example
Responses
| Status | Description |
|---|---|
| 200 | Extension Response |
Response Example (200)
Delete extensionLink copied!
DELETE /extensions/{id}
https://api.amplience.net/v2/content/extensions/{id}
Delete an Extension
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
extensionId | path | string | ✓ | Extension ID Example: 00112233445566778899aabb |
Responses
| Status | Description |
|---|---|
| 204 | Successfully removed the Extension |
List extensionsLink copied!
GET /hubs/{hubId}/extensions
https://api.amplience.net/v2/content/hubs/{hubId}/extensions
List all of the extension created for a hub.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | path | string | ✓ | Hub ID Example: 00112233445566778899aabb |
page | query | integer | Page number Example: 0 | |
size | query | integer | Page size Example: 20 | |
sort | query | string | Sort paramter Example: createdDate,asc |
Responses
| Status | Description |
|---|---|
| 200 | Paginated Extension List |
Response Example (200)
Create extensionLink copied!
POST /hubs/{hubId}/extensions
https://api.amplience.net/v2/content/hubs/{hubId}/extensions
Create a new Extension.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | path | string | ✓ | Hub ID Example: 00112233445566778899aabb |
Request Body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | ✓ | System name |
label | string | ✓ | User friendly name |
description | string | Description | |
url | string | ✓ | Url |
height | integer | Height of the extension | |
enabledForAllContentTypes | boolean | Sets whether the extension is globally enabled or intended for a specific content type | |
category | string (CONTENT_FIELD) | ✓ | Type of extension |
parameters | array | Array of config parameters | |
snippets | array | Array of snippets | |
settings | string | The settings parameter is used to store undefined extension settings such as security rule. |
Request example
Responses
| Status | Description |
|---|---|
| 200 | Create Extension |
Response Example (200)
Get extension by nameLink copied!
GET /hubs/{hubId}/extensions/{name}
https://api.amplience.net/v2/content/hubs/{hubId}/extensions/{name}
Return the extension with the specified name, in current hub.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | path | string | ✓ | Hub ID Example: 00112233445566778899aabb |
name | path | string | ✓ | Extension name Example: sample-name |
Responses
| Status | Description |
|---|---|
| 200 | Extension Response |
Response Example (200)
IntegrationsLink copied!
| Method | Endpoint | Summary |
|---|---|---|
GET | /hubs/{hubId}/integrations | List available integrations |
List available integrationsLink copied!
GET /hubs/{hubId}/integrations
https://api.amplience.net/v2/content/hubs/{hubId}/integrations
List all of the Integrations created for a hub (dependent on functional permissions)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | path | string | ✓ | Hub ID Example: 00112233445566778899aabb |
page | query | integer | Page number Example: 0 | |
size | query | integer | Page size Example: 20 | |
sort | query | string | Sort paramter Example: label,asc |
Responses
| Status | Description |
|---|---|
| 200 | Paginated Integration List |
Response Example (200)
Salesforce Commerce Cloud (SFCC)Link copied!
| Method | Endpoint | Summary |
|---|---|---|
GET | /integrations/sfcc | List SFCC integrations |
POST | /integrations/sfcc | Create SFCC integration |
GET | /integrations/sfcc/{integrationId} | Get a SFCC integration |
PATCH | /integrations/sfcc/{integrationId} | Update SFCC integration |
DELETE | /integrations/sfcc/{integrationId} | Delete SFCC integration |
List SFCC integrationsLink copied!
GET /integrations/sfcc
https://api.amplience.net/v2/content/integrations/sfcc
List all of the SFCC Integrations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | query | string | ✓ | Hub ID Example: 00112233445566778899aabb |
cursor | query | string | Cursor specific to a page | |
size | query | integer | Page size Example: 20 | |
sort | query | string | Sort paramter Example: label,asc |
Responses
| Status | Description |
|---|---|
| 200 | Paginated SFCC Integrations List |
Response Example (200)
Create SFCC integrationLink copied!
POST /integrations/sfcc
https://api.amplience.net/v2/content/integrations/sfcc
Create a SFCC Integration
Request Body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
hubId | string | ✓ | Hub ID |
label | string | ||
sfcc-credentials | object | ✓ | Credentials for integrating with SFCC |
dc-credentials | object | ✓ | Credentials for integrating with DC |
sfcc-api | object | ✓ | Details to use when communicating with SFCC |
contentSlots | object | ||
rendering | object | ✓ | Used for setting up content previews |
contentAssets | object | Filtering settings defining which content items are sent to SFCC | |
localeMappings | object | Locales to use when creating SFCC content, any valid locale can be used | |
lastInvocationTimestamp | object |
Request example
Responses
| Status | Description |
|---|---|
| 200 | SFCC Integration Create Response |
Response Example (200)
Get a SFCC integrationLink copied!
GET /integrations/sfcc/{integrationId}
https://api.amplience.net/v2/content/integrations/sfcc/{integrationId}
Get a specific SFCC Integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
integrationId | path | string | ✓ | Integration ID Example: 00112233-4455-6677-8899-aabbccddeeff |
Responses
| Status | Description |
|---|---|
| 200 | Requested SFCC Integration |
Response Example (200)
Update SFCC integrationLink copied!
PATCH /integrations/sfcc/{integrationId}
https://api.amplience.net/v2/content/integrations/sfcc/{integrationId}
Update an SFCC Integration
Request Body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
label | string | ||
sfcc-credentials | object | Credentials for integrating with SFCC | |
dc-credentials | object | Credentials for integrating with DC | |
sfcc-api | object | Details to use when communicating with SFCC | |
contentSlots | object | ||
rendering | object | Used for setting up content previews | |
contentAssets | object | Filtering settings defining which content items are sent to SFCC | |
localeMappings | object | Locales to use when creating SFCC content, any valid locale can be used | |
lastInvocationTimestamp | object |
Request example
Responses
| Status | Description |
|---|---|
| 200 | SFCC Integration Update Response |
Response Example (200)
Delete SFCC integrationLink copied!
DELETE /integrations/sfcc/{integrationId}
https://api.amplience.net/v2/content/integrations/sfcc/{integrationId}
Delete an SFCC Integration
Responses
| Status | Description |
|---|---|
| 204 | No Content |
Salesforce Marketing Cloud (SFMC)Link copied!
| Method | Endpoint | Summary |
|---|---|---|
GET | /integrations/sfmc | List SFMC integrations |
POST | /integrations/sfmc | Create SFMC integration |
GET | /integrations/sfmc/{integrationId} | Get a SFMC integration |
PATCH | /integrations/sfmc/{integrationId} | Update SFMC integration |
DELETE | /integrations/sfmc/{integrationId} | Delete SFMC integration |
List SFMC integrationsLink copied!
GET /integrations/sfmc
https://api.amplience.net/v2/content/integrations/sfmc
List all of the SFMC Integrations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | query | string | ✓ | Hub ID Example: 00112233445566778899aabb |
cursor | query | string | Cursor specific to a page | |
size | query | integer | Page size Example: 20 | |
sort | query | string | Sort paramter Example: label,asc |
Responses
| Status | Description |
|---|---|
| 200 | Paginated SFMC Integrations List |
Response Example (200)
Create SFMC integrationLink copied!
POST /integrations/sfmc
https://api.amplience.net/v2/content/integrations/sfmc
Create a SFMC Integration
Request Body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
hubId | string | ✓ | Hub ID |
label | string | ✓ | |
active | boolean | ✓ | |
sfmc-credentials | object | ✓ | Credentials for integrating with SFMC |
dc-credentials | object | ✓ | Credentials for integrating with DC |
rendering | object | ✓ | Used for setting up content previews |
contentAssets | object | ✓ | Settings to use when creating SFMC content |
Request example
Responses
| Status | Description |
|---|---|
| 200 | SFMC Integration Create Response |
Response Example (200)
Get a SFMC integrationLink copied!
GET /integrations/sfmc/{integrationId}
https://api.amplience.net/v2/content/integrations/sfmc/{integrationId}
Get a specific SFMC Integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
integrationId | path | string | ✓ | Integration ID Example: 00112233-4455-6677-8899-aabbccddeeff |
Responses
| Status | Description |
|---|---|
| 200 | Requested SFMC Integration |
Response Example (200)
Update SFMC integrationLink copied!
PATCH /integrations/sfmc/{integrationId}
https://api.amplience.net/v2/content/integrations/sfmc/{integrationId}
Update an SFMC Integration
Request Body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
label | string | ||
active | boolean | ||
sfmc-credentials | object | Credentials for integrating with SFMC | |
dc-credentials | object | Credentials for integrating with DC | |
rendering | object | Used for setting up content previews | |
contentAssets | object | Settings to use when creating SFMC content |
Request example
Responses
| Status | Description |
|---|---|
| 200 | SFMC Integration Update Response |
Response Example (200)
Delete SFMC integrationLink copied!
DELETE /integrations/sfmc/{integrationId}
https://api.amplience.net/v2/content/integrations/sfmc/{integrationId}
Delete an SFMC Integration
Responses
| Status | Description |
|---|---|
| 204 | No Content |