Extensions and integrations
Base URL: https://api.amplience.net/v2/content
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)
{
"hubId": "00112233445566778899aabb",
"name": "Extension-01",
"label": "Extension-01 first-draft",
"description": "This is a description of an extension.",
"url": "http://example.com",
"height": 400,
"enabledForAllContentTypes": false,
"category": "CONTENT_FIELD",
"parameters": [
{
"color": "blue"
}
],
"snippets": [
{
"label": "mySnippet",
"body": "{}"
}
],
"settings": "{\"API\":{\"READ\":true,\"EDIT\":true},\"SANDBOX\":{\"SAME_ORIGIN\":false,\"MODALS\":true,\"NAVIGATION\":true,\"POPUPS\":false,\"DOWNLOADS\":false,\"FORMS\":true}}",
"createdBy": "00112233-4455-6677-8899-aabbccddeeff",
"createdDate": "2019-01-01T00:00:00.000Z",
"lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
"lastModifiedDate": "2019-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"extension": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
}
}
}
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
{
"name": "Extension-01",
"label": "Extension-01 first-draft",
"description": "This is a description of an extension.",
"url": "http://example.com",
"height": 400,
"enabledForAllContentTypes": false,
"category": "CONTENT_FIELD",
"parameters": [
{
"color": "blue"
}
],
"snippets": [
{
"label": "mySnippet",
"body": "{}"
}
],
"settings": "{\"API\":{\"READ\":true,\"EDIT\":true},\"SANDBOX\":{\"SAME_ORIGIN\":false,\"MODALS\":true,\"NAVIGATION\":true,\"POPUPS\":false,\"DOWNLOADS\":false,\"FORMS\":true}}"
}
Responses
| Status | Description |
|---|
| 200 | Extension Response |
Response Example (200)
{
"hubId": "00112233445566778899aabb",
"name": "Extension-01",
"label": "Extension-01 first-draft",
"description": "This is a description of an extension.",
"url": "http://example.com",
"height": 400,
"enabledForAllContentTypes": false,
"category": "CONTENT_FIELD",
"parameters": [
{
"color": "blue"
}
],
"snippets": [
{
"label": "mySnippet",
"body": "{}"
}
],
"settings": "{\"API\":{\"READ\":true,\"EDIT\":true},\"SANDBOX\":{\"SAME_ORIGIN\":false,\"MODALS\":true,\"NAVIGATION\":true,\"POPUPS\":false,\"DOWNLOADS\":false,\"FORMS\":true}}",
"createdBy": "00112233-4455-6677-8899-aabbccddeeff",
"createdDate": "2019-01-01T00:00:00.000Z",
"lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
"lastModifiedDate": "2019-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"extension": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
}
}
}
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 |
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)
{
"_embedded": {
"extensions": [
{
"hubId": "00112233445566778899aabb",
"name": "Extension-01",
"label": "Extension-01 first-draft",
"description": "This is a description of an extension.",
"url": "http://example.com",
"height": 400,
"enabledForAllContentTypes": false,
"category": "CONTENT_FIELD",
"parameters": [
{
"color": "blue"
}
],
"snippets": [
{
"label": "mySnippet",
"body": "{}"
}
],
"settings": "{\"API\":{\"READ\":true,\"EDIT\":true},\"SANDBOX\":{\"SAME_ORIGIN\":false,\"MODALS\":true,\"NAVIGATION\":true,\"POPUPS\":false,\"DOWNLOADS\":false,\"FORMS\":true}}",
"createdBy": "00112233-4455-6677-8899-aabbccddeeff",
"createdDate": "2019-01-01T00:00:00.000Z",
"lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
"lastModifiedDate": "2019-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"extension": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/extensions?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/extensions?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/extensions?page=0&size=20"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
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
{
"name": "Extension-01",
"label": "Extension-01 first-draft",
"description": "This is a description of an extension.",
"url": "http://example.com",
"height": 400,
"enabledForAllContentTypes": false,
"category": "CONTENT_FIELD",
"parameters": [
{
"color": "blue"
}
],
"snippets": [
{
"label": "mySnippet",
"body": "{}"
}
],
"settings": "{\"API\":{\"READ\":true,\"EDIT\":true},\"SANDBOX\":{\"SAME_ORIGIN\":false,\"MODALS\":true,\"NAVIGATION\":true,\"POPUPS\":false,\"DOWNLOADS\":false,\"FORMS\":true}}"
}
Responses
| Status | Description |
|---|
| 200 | Create Extension |
Response Example (200)
{
"hubId": "00112233445566778899aabb",
"name": "Extension-01",
"label": "Extension-01 first-draft",
"description": "This is a description of an extension.",
"url": "http://example.com",
"height": 400,
"enabledForAllContentTypes": false,
"category": "CONTENT_FIELD",
"parameters": [
{
"color": "blue"
}
],
"snippets": [
{
"label": "mySnippet",
"body": "{}"
}
],
"settings": "{\"API\":{\"READ\":true,\"EDIT\":true},\"SANDBOX\":{\"SAME_ORIGIN\":false,\"MODALS\":true,\"NAVIGATION\":true,\"POPUPS\":false,\"DOWNLOADS\":false,\"FORMS\":true}}",
"createdBy": "00112233-4455-6677-8899-aabbccddeeff",
"createdDate": "2019-01-01T00:00:00.000Z",
"lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
"lastModifiedDate": "2019-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"extension": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
}
}
}
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)
{
"hubId": "00112233445566778899aabb",
"name": "Extension-01",
"label": "Extension-01 first-draft",
"description": "This is a description of an extension.",
"url": "http://example.com",
"height": 400,
"enabledForAllContentTypes": false,
"category": "CONTENT_FIELD",
"parameters": [
{
"color": "blue"
}
],
"snippets": [
{
"label": "mySnippet",
"body": "{}"
}
],
"settings": "{\"API\":{\"READ\":true,\"EDIT\":true},\"SANDBOX\":{\"SAME_ORIGIN\":false,\"MODALS\":true,\"NAVIGATION\":true,\"POPUPS\":false,\"DOWNLOADS\":false,\"FORMS\":true}}",
"createdBy": "00112233-4455-6677-8899-aabbccddeeff",
"createdDate": "2019-01-01T00:00:00.000Z",
"lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
"lastModifiedDate": "2019-01-01T00:00:00.000Z",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"extension": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/extensions/00112233445566778899aabb"
}
}
}
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)
{
"_embedded": {
"integrations": [
{
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/<type>?hubId=00112233445566778899aabb?page=0&size=20"
},
"list-integrations": {
"href": "https://api.amplience.net/v2/content/integrations/<type>?hubId=00112233445566778899aabb?page=0&size=20"
},
"create-integrations": {
"href": "https://api.amplience.net/v2/content/integrations/<type>?hubId=00112233445566778899aabb?page=0&size=20"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/integrations?page=0&size=20&sort=label,asc"
},
"first": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/integrations?page=0&size=20&sort=label,asc"
},
"last": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/integrations?page=1&size=20&sort=label,asc"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
Salesforce Commerce Cloud (SFCC)Link 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)
{
"_embedded": {
"integrations": [
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Commerce Cloud",
"hubId": "00112233445566778899aabb",
"sfcc-credentials": {
"id": "SFCC_ID",
"secret": "SFCC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"sfcc-api": {
"path": "https://example.com",
"version": "v18_10"
},
"contentSlots": {
"site": "mySite",
"ismlTemplate": "slots/html/htmlslotcontainer.isml"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io",
"htmlTemplate": "sfcc"
},
"contentAssets": {
"library": "default",
"contentRepository": "00112233445566778899aabb",
"contentTypes": [
{
"folders": []
}
]
},
"localeMappings": {
"default": "*",
"fr-FR": "fr-FR,en,*",
"de": "de-*,en-*,*"
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc?hubId=00112233445566778899aabb&cursor=page=0&size=20&sort=label,asc"
},
"integrations": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc{?hubId,cursor,page,size,sort}",
"templated": true
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
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
{
"hubId": "00112233445566778899aabb",
"label": "Salesforce Commerce Cloud",
"sfcc-credentials": {
"id": "SFCC_ID",
"secret": "SFCC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"sfcc-api": {
"path": "https://example.com",
"version": "v18_10"
},
"contentSlots": {
"site": "mySite",
"ismlTemplate": "slots/html/htmlslotcontainer.isml"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io",
"htmlTemplate": "sfcc"
},
"contentAssets": {
"library": "default",
"contentRepository": "00112233445566778899aabb",
"contentTypes": [
{
"contentType": "http://deliver.bigcontent.io/schema/banner-type.json",
"folders": [
{
"default": false,
"optional": false
}
],
"mappings": {
"id": {
"jsonPath": "$.body.sfcc_id",
"fallback": "fallback value"
},
"name": {
"jsonPath": "$.body.name",
"fallback": "fallback value"
},
"onlineFlag": {
"default": {
"jsonPath": "$.body.online",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site",
"fallback": "fallback value"
}
},
"description": {
"jsonPath": "$.body.description",
"fallback": "fallback value"
},
"siteMapPriority": {
"jsonPath": "$.body.siteMapPriority",
"fallback": "fallback value"
},
"defaultedBoolean": {
"default": {
"jsonPath": "$.body.defaultedBoolean",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_boolean",
"fallback": "fallback value"
}
},
"defaultedNumber": {
"default": {
"jsonPath": "$.body.defaultedNumber",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_number",
"fallback": "fallback value"
}
},
"defaultedObject": {
"default": {
"jsonPath": "$.body.defaultedObject",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_object",
"fallback": "fallback value"
}
},
"boolean_field": {
"jsonPath": "$.body.boolean_field",
"fallback": "fallback value"
}
}
}
]
},
"localeMappings": {
"default": "*",
"fr-FR": "fr-FR,en,*",
"de": "de-*,en-*,*"
}
}
Responses
| Status | Description |
|---|
| 200 | SFCC Integration Create Response |
Response Example (200)
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Commerce Cloud",
"hubId": "00112233445566778899aabb",
"sfcc-credentials": {
"id": "SFCC_ID",
"secret": "SFCC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"sfcc-api": {
"path": "https://example.com",
"version": "v18_10"
},
"contentSlots": {
"site": "mySite",
"ismlTemplate": "slots/html/htmlslotcontainer.isml"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io",
"htmlTemplate": "sfcc"
},
"contentAssets": {
"library": "default",
"contentRepository": "00112233445566778899aabb",
"contentTypes": [
{
"contentType": "http://deliver.bigcontent.io/schema/banner-type.json",
"folders": [
{
"default": false,
"optional": false
}
],
"mappings": {
"id": {
"jsonPath": "$.body.sfcc_id",
"fallback": "fallback value"
},
"name": {
"jsonPath": "$.body.name",
"fallback": "fallback value"
},
"onlineFlag": {
"default": {
"jsonPath": "$.body.online",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site",
"fallback": "fallback value"
}
},
"description": {
"jsonPath": "$.body.description",
"fallback": "fallback value"
},
"siteMapPriority": {
"jsonPath": "$.body.siteMapPriority",
"fallback": "fallback value"
},
"defaultedBoolean": {
"default": {
"jsonPath": "$.body.defaultedBoolean",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_boolean",
"fallback": "fallback value"
}
},
"defaultedNumber": {
"default": {
"jsonPath": "$.body.defaultedNumber",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_number",
"fallback": "fallback value"
}
},
"defaultedObject": {
"default": {
"jsonPath": "$.body.defaultedObject",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_object",
"fallback": "fallback value"
}
},
"boolean_field": {
"jsonPath": "$.body.boolean_field",
"fallback": "fallback value"
}
}
}
]
},
"localeMappings": {
"default": "*",
"fr-FR": "fr-FR,en,*",
"de": "de-*,en-*,*"
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
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)
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Commerce Cloud",
"hubId": "00112233445566778899aabb",
"sfcc-credentials": {
"id": "SFCC_ID",
"secret": "SFCC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"sfcc-api": {
"path": "https://example.com",
"version": "v18_10"
},
"contentSlots": {
"site": "mySite",
"ismlTemplate": "slots/html/htmlslotcontainer.isml"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io",
"htmlTemplate": "sfcc"
},
"contentAssets": {
"library": "default",
"contentRepository": "00112233445566778899aabb",
"contentTypes": [
{
"contentType": "http://deliver.bigcontent.io/schema/banner-type.json",
"folders": [
{
"default": false,
"optional": false
}
],
"mappings": {
"id": {
"jsonPath": "$.body.sfcc_id",
"fallback": "fallback value"
},
"name": {
"jsonPath": "$.body.name",
"fallback": "fallback value"
},
"onlineFlag": {
"default": {
"jsonPath": "$.body.online",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site",
"fallback": "fallback value"
}
},
"description": {
"jsonPath": "$.body.description",
"fallback": "fallback value"
},
"siteMapPriority": {
"jsonPath": "$.body.siteMapPriority",
"fallback": "fallback value"
},
"defaultedBoolean": {
"default": {
"jsonPath": "$.body.defaultedBoolean",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_boolean",
"fallback": "fallback value"
}
},
"defaultedNumber": {
"default": {
"jsonPath": "$.body.defaultedNumber",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_number",
"fallback": "fallback value"
}
},
"defaultedObject": {
"default": {
"jsonPath": "$.body.defaultedObject",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_object",
"fallback": "fallback value"
}
},
"boolean_field": {
"jsonPath": "$.body.boolean_field",
"fallback": "fallback value"
}
}
}
]
},
"localeMappings": {
"default": "*",
"fr-FR": "fr-FR,en,*",
"de": "de-*,en-*,*"
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
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
{
"label": "Salesforce Commerce Cloud",
"sfcc-credentials": {
"id": "SFCC_ID",
"secret": "SFCC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"sfcc-api": {
"path": "https://example.com",
"version": "v18_10"
},
"contentSlots": {
"site": "mySite",
"ismlTemplate": "slots/html/htmlslotcontainer.isml"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io",
"htmlTemplate": "sfcc"
},
"contentAssets": {
"library": "default",
"contentRepository": "00112233445566778899aabb",
"contentTypes": [
{
"contentType": "http://deliver.bigcontent.io/schema/banner-type.json",
"folders": [
{
"default": false,
"optional": false
}
],
"mappings": {
"id": {
"jsonPath": "$.body.sfcc_id",
"fallback": "fallback value"
},
"name": {
"jsonPath": "$.body.name",
"fallback": "fallback value"
},
"onlineFlag": {
"default": {
"jsonPath": "$.body.online",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site",
"fallback": "fallback value"
}
},
"description": {
"jsonPath": "$.body.description",
"fallback": "fallback value"
},
"siteMapPriority": {
"jsonPath": "$.body.siteMapPriority",
"fallback": "fallback value"
},
"defaultedBoolean": {
"default": {
"jsonPath": "$.body.defaultedBoolean",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_boolean",
"fallback": "fallback value"
}
},
"defaultedNumber": {
"default": {
"jsonPath": "$.body.defaultedNumber",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_number",
"fallback": "fallback value"
}
},
"defaultedObject": {
"default": {
"jsonPath": "$.body.defaultedObject",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_object",
"fallback": "fallback value"
}
},
"boolean_field": {
"jsonPath": "$.body.boolean_field",
"fallback": "fallback value"
}
}
}
]
},
"localeMappings": {
"default": "*",
"fr-FR": "fr-FR,en,*",
"de": "de-*,en-*,*"
}
}
Responses
| Status | Description |
|---|
| 200 | SFCC Integration Update Response |
Response Example (200)
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Commerce Cloud",
"hubId": "00112233445566778899aabb",
"sfcc-credentials": {
"id": "SFCC_ID",
"secret": "SFCC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"sfcc-api": {
"path": "https://example.com",
"version": "v18_10"
},
"contentSlots": {
"site": "mySite",
"ismlTemplate": "slots/html/htmlslotcontainer.isml"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io",
"htmlTemplate": "sfcc"
},
"contentAssets": {
"library": "default",
"contentRepository": "00112233445566778899aabb",
"contentTypes": [
{
"contentType": "http://deliver.bigcontent.io/schema/banner-type.json",
"folders": [
{
"default": false,
"optional": false
}
],
"mappings": {
"id": {
"jsonPath": "$.body.sfcc_id",
"fallback": "fallback value"
},
"name": {
"jsonPath": "$.body.name",
"fallback": "fallback value"
},
"onlineFlag": {
"default": {
"jsonPath": "$.body.online",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site",
"fallback": "fallback value"
}
},
"description": {
"jsonPath": "$.body.description",
"fallback": "fallback value"
},
"siteMapPriority": {
"jsonPath": "$.body.siteMapPriority",
"fallback": "fallback value"
},
"defaultedBoolean": {
"default": {
"jsonPath": "$.body.defaultedBoolean",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_boolean",
"fallback": "fallback value"
}
},
"defaultedNumber": {
"default": {
"jsonPath": "$.body.defaultedNumber",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_number",
"fallback": "fallback value"
}
},
"defaultedObject": {
"default": {
"jsonPath": "$.body.defaultedObject",
"fallback": "fallback value"
},
"mySite": {
"jsonPath": "$.body.site_object",
"fallback": "fallback value"
}
},
"boolean_field": {
"jsonPath": "$.body.boolean_field",
"fallback": "fallback value"
}
}
}
]
},
"localeMappings": {
"default": "*",
"fr-FR": "fr-FR,en,*",
"de": "de-*,en-*,*"
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfcc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
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!
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)
{
"_embedded": {
"integrations": [
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Marketing Cloud",
"active": true,
"hubId": "00112233445566778899aabb",
"sfmc-credentials": {
"id": "SFMC_ID",
"secret": "SFMC_SECRET",
"authDomain": "SFMC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io"
},
"contentAssets": {
"topLevelFolder": "myFolder",
"contentTypeSchemas": [
{
"htmlTemplate": "sfmc"
}
]
},
"lastInvocationTimestamp": 1234567890,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc?hubId=00112233445566778899aabb&cursor=page=0&size=20&sort=label,asc"
},
"integrations": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc{?hubId,cursor,page,size,sort}",
"templated": true
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
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
{
"hubId": "00112233445566778899aabb",
"label": "Salesforce Marketing Cloud",
"active": true,
"sfmc-credentials": {
"id": "SFMC_ID",
"secret": "SFMC_SECRET",
"authDomain": "SFMC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io"
},
"contentAssets": {
"topLevelFolder": "myFolder",
"contentTypeSchemas": [
{
"htmlTemplate": "sfmc"
}
]
}
}
Responses
| Status | Description |
|---|
| 200 | SFMC Integration Create Response |
Response Example (200)
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Marketing Cloud",
"active": true,
"hubId": "00112233445566778899aabb",
"sfmc-credentials": {
"id": "SFMC_ID",
"secret": "SFMC_SECRET",
"authDomain": "SFMC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io"
},
"contentAssets": {
"topLevelFolder": "myFolder",
"contentTypeSchemas": [
{
"htmlTemplate": "sfmc"
}
]
},
"lastInvocationTimestamp": 1234567890,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
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)
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Marketing Cloud",
"active": true,
"hubId": "00112233445566778899aabb",
"sfmc-credentials": {
"id": "SFMC_ID",
"secret": "SFMC_SECRET",
"authDomain": "SFMC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io"
},
"contentAssets": {
"topLevelFolder": "myFolder",
"contentTypeSchemas": [
{
"htmlTemplate": "sfmc"
}
]
},
"lastInvocationTimestamp": 1234567890,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
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
{
"label": "Salesforce Marketing Cloud",
"active": true,
"sfmc-credentials": {
"id": "SFMC_ID",
"secret": "SFMC_SECRET",
"authDomain": "SFMC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io"
},
"contentAssets": {
"topLevelFolder": "myFolder",
"contentTypeSchemas": [
{
"htmlTemplate": "sfmc"
}
]
}
}
Responses
| Status | Description |
|---|
| 200 | SFMC Integration Update Response |
Response Example (200)
{
"id": "00112233-4455-6677-8899-aabbccddeeff",
"label": "Salesforce Marketing Cloud",
"active": true,
"hubId": "00112233445566778899aabb",
"sfmc-credentials": {
"id": "SFMC_ID",
"secret": "SFMC_SECRET",
"authDomain": "SFMC_SECRET"
},
"dc-credentials": {
"id": "DC_ID",
"secret": "DC_SECRET"
},
"rendering": {
"vseDomain": "00112233445566778899aabb.staging.bigcontent.io"
},
"contentAssets": {
"topLevelFolder": "myFolder",
"contentTypeSchemas": [
{
"htmlTemplate": "sfmc"
}
]
},
"lastInvocationTimestamp": 1234567890,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"webhook": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff/webhook"
},
"update": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"delete": {
"href": "https://api.amplience.net/v2/content/integrations/sfmc/00112233-4455-6677-8899-aabbccddeeff"
},
"webhook-subscription": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks/00112233445566778899aabb"
}
}
}
DELETE /integrations/sfmc/{integrationId}
https://api.amplience.net/v2/content/integrations/sfmc/{integrationId}
Delete an SFMC Integration
Responses
| Status | Description |
|---|
| 204 | No Content |