{ "_": { "postman_id": "11f16d15-cb07-480e-9323-b501c0261e7e" }, "item": [ { "id": "052c7b0d-6761-4fed-95d2-f0858862f0b2", "name": "Smart Content", "description": { "content": "all API endpoints related to general Smart Content recommendations.", "type": "text/plain" }, "item": [ { "id": "8734f71c-9345-4700-8a05-afefdb042fd1", "name": "Get general recommendations", "request": { "name": "Get general recommendations", "description": { "content": "Get top-N items recommendations.\n\nThe most typical use cases are recommendations at overview pages like a homepage or category pages.\n", "type": "text/plain" }, "url": { "path": [ ":customerId", "r" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The widget ID refers to the Smart Content configuration.\nThe configuration decides which algorithm & filter conditions will be used for the recommendations prediction.", "type": "text/plain" }, "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "disabled": false, "description": { "content": "(Required) The `lang` parameter is indication to language context. This will influence the translation of the recommended items.", "type": "text/plain" }, "key": "lang", "value": "nl" }, { "disabled": false, "description": { "content": "The `loc` parameter is indication to location or country context. This will influence the country based offering of the recommended items.", "type": "text/plain" }, "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "9a31e4f6-a880-43ac-9e5b-114dca6ea066", "name": "Successful response", "originalRequest": { "url": { "path": [ ":customerId", "r" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "key": "lang", "value": "nl" }, { "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"item_pid\": \"SKU-12\",\n \"score\": 5,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/12?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/swimsuit-12.html\",\n \"first_category\": \"Women Clothing\",\n \"cat_id\": [\n \"250\"\n ]\n },\n {\n \"item_pid\": \"SKU-15\",\n \"score\": 4,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/15?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/trousers-12.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n },\n {\n \"item_pid\": \"SKU-5\",\n \"score\": 3,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/5?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/jacket-14.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n }\n]", "cookie": [] } ], "event": [] }, { "id": "a713c1a1-cbd3-48f4-89f7-294b6eacf935", "name": "Get general personalised recommendations", "request": { "name": "Get general personalised recommendations", "description": { "content": "Based on user’s past interactions (purchases, view, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.\n\nThe most typical use cases are recommendations at overview pages like a homepage or category pages.\n", "type": "text/plain" }, "url": { "path": [ ":customerId", "r", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The widget ID refers to the Smart Content configuration.\nThe configuration decides which algorithm & filter conditions will be used for the recommendations prediction.", "type": "text/plain" }, "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "disabled": false, "description": { "content": "(Required) The Selligent system ID of the contact who will see the recommendations.", "type": "text/plain" }, "key": "tpid", "value": "123456789" }, { "disabled": false, "description": { "content": "The Selligent Site profile ID reference.", "type": "text/plain" }, "key": "sid", "value": "abc12345-ae74-40ad-a9df-9c9107cdf6c8" }, { "disabled": false, "description": { "content": "(Required) The `lang` parameter is indication to language context. This will influence the translation of the recommended items.", "type": "text/plain" }, "key": "lang", "value": "nl" }, { "disabled": false, "description": { "content": "The `loc` parameter is indication to location or country context. This will influence the country based offering of the recommended items.", "type": "text/plain" }, "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "d3209c12-4bab-4acf-9b01-5e11ce90b8fd", "name": "Successful response", "originalRequest": { "url": { "path": [ ":customerId", "r", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "key": "tpid", "value": "123456789" }, { "key": "sid", "value": "abc12345-ae74-40ad-a9df-9c9107cdf6c8" }, { "key": "lang", "value": "nl" }, { "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"item_pid\": \"SKU-12\",\n \"score\": 5,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/12?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/swimsuit-12.html\",\n \"first_category\": \"Women Clothing\",\n \"cat_id\": [\n \"250\"\n ]\n },\n {\n \"item_pid\": \"SKU-15\",\n \"score\": 4,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/15?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/trousers-12.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n },\n {\n \"item_pid\": \"SKU-5\",\n \"score\": 3,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/5?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/jacket-14.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n }\n]", "cookie": [] } ], "event": [] }, { "id": "837a6224-d9a5-4b07-961f-9309f25da3dd", "name": "Get recommendations for an item", "request": { "name": "Get recommendations for an item", "description": { "content": "Get recommendations for a specific item.\n\nThe typical use-case is to offer \"related items\" or \"compatible items\" in relation to the specified item.\n\nThe returned items are sorted by relevance (first item being the most relevant).\n", "type": "text/plain" }, "url": { "path": [ ":customerId", "rp", ":itemPid", ":item" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The widget ID refers to the Smart Content configuration.\nThe configuration decides which algorithm & filter conditions will be used for the recommendations prediction.", "type": "text/plain" }, "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "disabled": false, "description": { "content": "(Required) The `lang` parameter is indication to language context. This will influence the translation of the recommended items.", "type": "text/plain" }, "key": "lang", "value": "nl" }, { "disabled": false, "description": { "content": "The `loc` parameter is indication to location or country context. This will influence the country based offering of the recommended items.", "type": "text/plain" }, "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The item/product ID, like it is referenced by the customer. Typically this is like the item SKU or another unique reference to the item. The ID of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "itemPid" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "8a0fc1eb-0081-4655-91e0-091148f12546", "name": "Successful response", "originalRequest": { "url": { "path": [ ":customerId", "rp", ":itemPid", ":item" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "key": "lang", "value": "nl" }, { "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The item/product ID, like it is referenced by the customer. Typically this is like the item SKU or another unique reference to the item. The ID of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "itemPid" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"item_pid\": \"SKU-12\",\n \"score\": 5,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/12?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/swimsuit-12.html\",\n \"first_category\": \"Women Clothing\",\n \"cat_id\": [\n \"250\"\n ]\n },\n {\n \"item_pid\": \"SKU-15\",\n \"score\": 4,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/15?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/trousers-12.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n },\n {\n \"item_pid\": \"SKU-5\",\n \"score\": 3,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/5?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/jacket-14.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n }\n]", "cookie": [] } ], "event": [] }, { "id": "d91c62e2-72c4-45e7-9bf4-a7e967c47d0e", "name": "Get personalised recommendations for an item", "request": { "name": "Get personalised recommendations for an item", "description": { "content": "Get personalised recommendations for a specific item.\n\nThe typical use-case is to offer \"related items\" or \"compatible items\" in relation to the specified item, which includes the past preference of the visitor.\n\nThe returned items are sorted by relevance (first item being the most relevant).\n", "type": "text/plain" }, "url": { "path": [ ":customerId", "rp", ":itemPid", ":item", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The widget ID refers to the Smart Content configuration.\nThe configuration decides which algorithm & filter conditions will be used for the recommendations prediction.", "type": "text/plain" }, "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "disabled": false, "description": { "content": "(Required) The Selligent system ID of the contact who will see the recommendations.", "type": "text/plain" }, "key": "tpid", "value": "123456789" }, { "disabled": false, "description": { "content": "The Selligent Site profile ID reference.", "type": "text/plain" }, "key": "sid", "value": "abc12345-ae74-40ad-a9df-9c9107cdf6c8" }, { "disabled": false, "description": { "content": "(Required) The `lang` parameter is indication to language context. This will influence the translation of the recommended items.", "type": "text/plain" }, "key": "lang", "value": "nl" }, { "disabled": false, "description": { "content": "The `loc` parameter is indication to location or country context. This will influence the country based offering of the recommended items.", "type": "text/plain" }, "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The item/product ID, like it is referenced by the customer. Typically this is like the item SKU or another unique reference to the item. The ID of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "itemPid" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "cabf12ba-0b5b-4143-bd85-542c9e8f34cf", "name": "Successful response", "originalRequest": { "url": { "path": [ ":customerId", "rp", ":itemPid", ":item", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "key": "tpid", "value": "123456789" }, { "key": "sid", "value": "abc12345-ae74-40ad-a9df-9c9107cdf6c8" }, { "key": "lang", "value": "nl" }, { "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The item/product ID, like it is referenced by the customer. Typically this is like the item SKU or another unique reference to the item. The ID of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "itemPid" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"item_pid\": \"SKU-12\",\n \"score\": 5,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/12?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/swimsuit-12.html\",\n \"first_category\": \"Women Clothing\",\n \"cat_id\": [\n \"250\"\n ]\n },\n {\n \"item_pid\": \"SKU-15\",\n \"score\": 4,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/15?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/trousers-12.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n },\n {\n \"item_pid\": \"SKU-5\",\n \"score\": 3,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/5?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/jacket-14.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n }\n]", "cookie": [] } ], "event": [] }, { "id": "dbb4d356-0658-4d3a-99e7-77432dbcfcdb", "name": "Get recommendations based on the context", "request": { "name": "Get recommendations based on the context", "description": { "content": "Recommends set of items that are related to passed contex.\nThe items returned are selected and sorted based on the relevance for the provided context.\n\nThe returned items are sorted by relevance (first item being the most relevant).\n", "type": "text/plain" }, "url": { "path": [ ":customerId", "r", ":item" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The widget ID refers to the Smart Content configuration.\nThe configuration decides which algorithm & filter conditions will be used for the recommendations prediction.", "type": "text/plain" }, "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "disabled": false, "description": { "content": "(Required) The `lang` parameter is indication to language context. This will influence the translation of the recommended items.", "type": "text/plain" }, "key": "lang", "value": "nl" }, { "disabled": false, "description": { "content": "The `loc` parameter is indication to location or country context. This will influence the country based offering of the recommended items.", "type": "text/plain" }, "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "827cddb6-99f8-4e51-8cb0-a04db413cab4", "name": "Successful response", "originalRequest": { "url": { "path": [ ":customerId", "r", ":item" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "key": "lang", "value": "nl" }, { "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"item_pid\": \"SKU-12\",\n \"score\": 5,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/12?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/swimsuit-12.html\",\n \"first_category\": \"Women Clothing\",\n \"cat_id\": [\n \"250\"\n ]\n },\n {\n \"item_pid\": \"SKU-15\",\n \"score\": 4,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/15?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/trousers-12.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n },\n {\n \"item_pid\": \"SKU-5\",\n \"score\": 3,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/5?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/jacket-14.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n }\n]", "cookie": [] } ], "event": [] }, { "id": "1c1f888f-f993-49a6-ad97-5ae4446a4f72", "name": "Get personalised recommendations based on the context", "request": { "name": "Get personalised recommendations based on the context", "description": { "content": "Recommends set of items that are related to passed \"contex\", where the past history of a user is taken into account, allowing personalised recommendations.\nThe items returned are selected and sorted based on the relevance for the provided user and context.\n\nThe returned items are sorted by relevance (first item being the most relevant).\n", "type": "text/plain" }, "url": { "path": [ ":customerId", "r", ":item", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The widget ID refers to the Smart Content configuration.\nThe configuration decides which algorithm & filter conditions will be used for the recommendations prediction.", "type": "text/plain" }, "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "disabled": false, "description": { "content": "(Required) The Selligent system ID of the contact who will see the recommendations.", "type": "text/plain" }, "key": "tpid", "value": "123456789" }, { "disabled": false, "description": { "content": "The Selligent Site profile ID reference.", "type": "text/plain" }, "key": "sid", "value": "abc12345-ae74-40ad-a9df-9c9107cdf6c8" }, { "disabled": false, "description": { "content": "(Required) The `lang` parameter is indication to language context. This will influence the translation of the recommended items.", "type": "text/plain" }, "key": "lang", "value": "nl" }, { "disabled": false, "description": { "content": "The `loc` parameter is indication to location or country context. This will influence the country based offering of the recommended items.", "type": "text/plain" }, "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "2cbc786c-fdba-4069-81c0-b9d918a88faa", "name": "Successful response", "originalRequest": { "url": { "path": [ ":customerId", "r", ":item", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "widgetid", "value": "6f390e664f8c4657b8f88212e98099e1" }, { "key": "tpid", "value": "123456789" }, { "key": "sid", "value": "abc12345-ae74-40ad-a9df-9c9107cdf6c8" }, { "key": "lang", "value": "nl" }, { "key": "loc", "value": "be" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the customer. This refers to the uniquer customer property, which is be defined during the customer activation within Recommendations'.", "type": "text/plain" }, "type": "any", "value": "1234567890", "key": "customerId" }, { "disabled": false, "description": { "content": "(Required) The base64 encoded page URL of the item/product. The URL reference of the item for which the recommendations are to be generated.", "type": "text/plain" }, "type": "any", "value": "aHR0cHM6Ly93d3cuc2VsbGlnZW50LmNvbS9wbGF0Zm9ybS9jYXBhYmlsaXRpZXMvYWktbWFjaGluZS1sZWFybmluZw==", "key": "item" } ] }, "header": [ { "disabled": false, "description": { "content": "The response format for the data that will be returned.", "type": "text/plain" }, "key": "accept", "value": "application/json;version=1" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"item_pid\": \"SKU-12\",\n \"score\": 5,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/12?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/swimsuit-12.html\",\n \"first_category\": \"Women Clothing\",\n \"cat_id\": [\n \"250\"\n ]\n },\n {\n \"item_pid\": \"SKU-15\",\n \"score\": 4,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/15?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/trousers-12.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n },\n {\n \"item_pid\": \"SKU-5\",\n \"score\": 3,\n \"tracking_url\": \"https://offer.slgnt.eu/api/6f390e664f8c4657b8f88212e98099e1/followedp/5?dId=wjDoTMuEZ-6DXwr4OgJCazlefBpUvoxUHot&lang=fr&loc=be&widgetid=sample\",\n \"item_url\": \"https://www.example.com/catalog/jacket-14.html\",\n \"first_category\": \"Men Clothing\",\n \"cat_id\": [\n \"270\"\n ]\n }\n]", "cookie": [] } ], "event": [] } ], "event": [] }, { "id": "47896d32-494f-4a24-a61f-f9a92d00c96a", "name": "Site", "description": { "content": "all API endpoints related to lookup user identification data.", "type": "text/plain" }, "item": [ { "id": "3483caad-9cc7-4254-ba17-d0f1cb0de0c7", "name": "Get Selligent User identification", "request": { "name": "Get Selligent User identification", "description": { "content": "Get the SITE profile identify based on an internal customer identifier.\n", "type": "text/plain" }, "url": { "path": [ "track" ], "host": [ "{{track-Url}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Domain that is defined in the SITE universe settings (normally domain from the website).", "type": "text/plain" }, "key": "origin", "value": "https://www.example.com" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"universeId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customIdentifier\": \"1234567abc123\",\n \"isEvent\": true,\n \"isIdentificationRequest\": true,\n \"isTargeting\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "c9305b13-916a-4f93-999c-f4776b42dbe0", "name": "Successful response", "originalRequest": { "url": { "path": [ "track" ], "host": [ "{{track-Url}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Domain that is defined in the SITE universe settings (normally domain from the website).", "type": "text/plain" }, "key": "origin", "value": "https://www.example.com" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"universeId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customIdentifier\": \"1234567abc123\",\n \"isEvent\": true,\n \"isIdentificationRequest\": true,\n \"isTargeting\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"profileId\": \"123ABCD45678iY2Q0LWJhNGE4NjFkNzFkMDNmI3MjdjNzYtMWQ2ZC00NTZkLThhYzYtYzQ1ZGM2ZTRmYjg4OzczMTY4OTszNjIsz\",\n \"profileInfo\": {\n \"universeId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customIdentifier\": \"1234567abc129\",\n \"isEvent\": true,\n \"isIdentificationRequest\": true,\n \"isTargeting\": false\n },\n \"doNotTrack\\\"\": false,\n \"$$profileId\": \"abc12345-ae74-40ad-a9df-9c9107cdf6c8\",\n \"$$thirdPartyId\": \"123456789\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://offer.slgnt.eu/api", "key": "baseUrl" }, { "type": "string", "value": "https://site-see.slgnt.eu/frontend/api", "key": "track-Url" } ], "info": { "_postman_id": "11f16d15-cb07-480e-9323-b501c0261e7e", "name": "Recommendations REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Recommendations API Reference\n\nThe Recommendation API gives you direct access to Recommendations.\n\nThis is intended for backend usage to expose your data if used from a frontend implementation. \n\n# How to integrate\n\nThere are 2 parts linked to the integration of Recommendations:\n1. [Interaction tracking](#section/How-to-integrate/Interaction-tracking)\n2. [Requesting recommendations](#section/How-to-integrate/Requesting-recommendations)\n\n## Interaction tracking\n\nBy enabling the Recommendations module, you can leverage the automatic installation of the Recommendations tracking JS script, via the SITE JS script tag.\n\nThe Recommendations JS tag will collect relevant interactions of users with the customer website like: page views, clicks, add-to-carts, ...\nThe interactions are the most valuable information for the algorithms in Recommendations recommendation engine. \nThese interactions are captured automatically.\n\n## Requesting recommendations\n\nFor requesting and showing recommendations, Recommendations provides an integration for the web which consist out of three principal options:\n\n1. By using the HTML Widgets provided by Recommendations\n2. By an implementation via the Recommendations Javascript SDK\n3. By fetching JSON recommendations via the Recommendations REST API\n\nThis documentation focuses on the Recommendations REST API, for more information on the other implementations reach out to your Selligent contact. \n\n# Getting started\n\nRecommendations uses a wide range of information to make recommendations. \nThe AI engine can make personalised recommendations but to be able to do this, it is required to properly identify the user.\n\nThe user identities & identification are provided by Selligent SITE product.\nYou cannot use your own customer identifiers when requesting personalised recommendations from Recommendations, but you can use the Site profile identifiers when communicating with Recommendations.\n\nTo be able to request personalised recommendations, follow this 2-step process:\n1. Request the Site profile for a User\n2. Request Recommendations recommendations for the Site profile\n\n![](assets/img/sequence-site-cortex.svg)\n\n## Request Site profile\n\nA typical situation is when you have an internal user reference. \nIn the example below, we will use a \"user_ID\" with reference `99999`.\n\nBy doing a Site profile lookup, you can get the Selligent profile reference back.\nThe step below uses the API to lookup a Site profile. All the details for the Site endpoint can be found under the\n[Site Identifcation](#operation/get-personalisation-identification) section.\n\n```json\nPOST https://site-see.slgnt.eu/frontend/api/track\n```\n\nwith the following JSON properties in the request body:\n```JSON\n{\n \"universeId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"customIdentifier\": \"99999\",\n \"referer\": \"https://www.google.be/\",\n \"isEvent\": true,\n \"isIdentificationRequest\": true,\n \"isTargeting\": false\n}\n```\n\nImportant to know are the properties:\n- `universeId` : refers to your instance setup for Site, which is can found in the Site configuration.\n- `customIdentifier` : refers to the internal user reference, which would be the \"user_ID\" `12345` from example\n\nThe response body would contain the following information:\n```JSON\n{\n \"profileId\": \"123ABCD45678iY2Q0LWJhNGE4NjFkNzFkMDNmI3MjdjNzYtMWQ2ZC00NTZkL\",\n \"profileInfo\": { },\n \"doNotTrack\": false,\n \"$$profileId\": \"abc12345-ae74-a40ad\",\n \"$$thirdPartyId\": \"a123456789\"\n}\n```\n\n## Request Smart Content recommendations\n\nFrom the Site profile response, you need to extract the `$$profileId` and the `$$thirdPartyId`.\nBy passing these properties you can request Recommendations to return personalised recommendations.\n\nIn the recommendations API you can pass the Site profile properties, by mapping the `sid` & `tpid`.\n\n```JSON\nGET https://offer.slgnt.eu/api/abc123456/r?widgetid=demo&sid=abc12345-ae74-a40ad&tpid=a123456789&lang=nl&loc=be\n``` \n\n- `$$thirdPartyId` is mapped to the Selligent system ID of the contact `tpid` (Required)\n- `$$profileId` is mapped to the Site profile ID reference `sid` (Optional)\n\n\nAll the options and properties for the Recommendations recommendations endpoints can be found under the\n[Smart Content Recommendations Identifcation](#tag/Smart-Content) section.\n\n# REST API basics\n\n## Domain\n\nThe Recommendation API can be reached from multiple domains, each specific to a region. You should use the\ndomain that matches the region where your data is stored and processed. You can use one of the following\ndomains:\n - **Europe**: https://offer.slgnt.eu\n - **United States**: https://offer.slgnt.us\n \n ## URI structure\n \n Structure:\n \n ```\n https://domain/api/{customer}/operation?params\n ```\n\nExample:\n\n```\nhttps://offer.slgnt.eu/api/abc123456/r?widgetid=demo&lang=nl&loc=be\n```\n**Definition:**\n\n0. _Part 0_: **domain** - The base url is a reference to your regional domain.\n1. _Part 1_: **api** - Refers to the API feature of the Recommendations product\n2. _Part 2_: **customer** - Refers to the unique identifier for a customer. \n3. _Part 3_: **operation** - Refers to Recommendations operations.\n4. _Part 4_: **params** - Refers to specific input parameters to instruct the operation.\n\n## Request Format\n\nThe API is publicly available without credentials.\nBy passing the `accept-format` you can define the content negotiation and the Recommendations engine will respond in \nthe desired format.\n\nWhen the `accept-format` is not passed along, the API will respond with in the HTML format.\n\nSupported content negotiation:\n- **accept: application/json** Responds with the data in JSON format\n- **accept: application/html** Responds with the data in HTML format\n\n## Response Format\nThe response format will respect the `accept-format` to respond the data in the requested format.\n\nWhether a request succeeded is indicated by the HTTP status code. \nA 2xx status code indicates success, whereas a 4xx or 5xx status code indicates failure. \n\nWhen a request fails, the response body is still JSON, but always contains the field message which you can inspect for debugging purposes.\n\n### Response properties\n\nThe response will contain a set of fixed properties (see endpoint documentation), which can be extended by any field that is available in the catalog.\n\nBy marking the \"This field will be sent with the API responses as\", this field will be included in the JSON response as a property of the recommendation item object.\n\n![](assets/img/cortex-catalog-fields.png)\n\nIt is even possible to specify a custom property name, like in the example below, where the catalog field `PRODUCT` will be returned as the property `TITLE` .\n\n![](assets/img/cortex-catalog-fields-1.png)\n\n## Versioning \n\nThe Recommendations API is versioned to allow versions with new functionality or changes be released without impact of existing\nimplementations.\n\nWhen we make improvements to the current version of the API endpoints, we strive to make only backwards-incompatible changes.\nWe release regularly improvements or new endpoints. Read our API changelog to stay up-to-date with the latest changes.\n\nYou can modify the accept header to specify a version, for example:\n\n```ruby\ncurl -L \"https://offer.slgnt.eu/api/abc123456/r?widgetid=demo&lang=nl&loc=be\"\n -H \"accept: application/json;version=1\"\n```\n\nWhich will respond with the content format of `version=1` and with the response format `application/json`.\n\nThe version parameter is optional. By not specifying the version, the latest version will be used.\n\n## Response codes\nSelligent uses the conventional HTTP response codes to indicate successful or failed API requests.\n\nCodes in the `2xx` range indicate success.\n\nCodes in the `4xx` range indicate an input related error or validation restrictions.\n\nCodes in the `5xx` range indicate an error with Selligent servers.\n\n| HTTP Status Codes | Description |\n| -------------------------- | ---------------------------------------------------------------------------------- |\n| 200 - OK | We found the request resource |\n| 201 - Created | The resource is successfully created |\n| 204 - No Content | The requested resources is empty |\n| 400 - Bad Request | There was an error with the request. The body of the response will have more info. |\n| 401 - Unauthorized | The access key was incorrect |\n| 404 - Not found | The resources cannot be found |\n| 405 - Method Not Allowed | The method is not allowed |\n| 408 - Request Timeout | The request is taking too long to respond |\n| 422 - Unprocessable Entity | The resource couldn't be created |\n| 429 - Too Many Requests | Too many requests hit the API too quickly |\n| 5xx - Server errors | Something went wrong on our end. Please try again |\n\n\nContact Support:\n Name: Team Synapse\n Email: info@zetaglobal.com", "type": "text/plain" } } }