Creëer

Maak een nieuwe widget. Er zijn 2 soorten widgets voor product reviews met verschillende aanpassingsmogelijkheden en gebruikersopties.

De “product-summary” widget toont een beknopte versie van de gemiddelde score van het product, de sterren en het aantal reviews dat is verzameld. Deze widget kan perfect onder de titel van het product op de productpagina en voor elk product op de productcategoriepagina en product secties worden geplaatst.
De “product-extended’ widget toont de gemiddelde score van het product, sterren, het aantal reviews, de score verdeling en alle product reviews in een scrolbaren zijbalk, pop-up of in lijn blok, wat jouw voorkeur is. Als je de zijbalk of het pop-up type gebruikt, wordt de widget getoond wanneer er op “product-summary” wordt geklikt. Deze widget kan daarom ook het best op de productpagina getoond worden.

Wanneer de code is gemaakt, kun je de embed code gebruiken om in je webshop te plaatsen. Bekijk de embed sectie hieronder voor meer uitleg.

Request

Headers

De “Authorization” header voor deze API methode bevat een <access_token> plaatshouder. Vervang deze met de waarde van een echte access token.

Name	Value
Authorization	Bearer <access_token>

URL

Name	Value
Method	POST
Endpoint	https://www.feedbackcompany.com/api/v2/widgets

Body

Deze API-methode accepteert een JSON body in het verzoek. Het top-level JSON object moet een “Widget” object zijn zoals beschreven in de volgende sectie.

Widget

Name	Allowed values	Required
type	"product-summary","product-extended"	Yes
options	(Depends on the widget type, see table below)	(Depends on the widget type, see table below)

Elk widget type heeft zijn eigen Options object:

Widet type	Options object	Required
product-summary	-	No
product-extended	(A "ProductExtendedOptions" Object	Yes

Product-summary

Voorbeeld Call

{
    "type": "product-summary",
}

Responses

Headers

Name	Value
Status code	201
Status message	Created

Voorbeeld resultaat

{
    "success": true,
    "widget": {
        "shop_id": 7751,
        "options": null,
        "create_timestamp": "2021-07-22T15:47:14Z",
        "uuid": "c6da43c2-aa0f-4c2a-adf3-69bf85548b44",
        "last_access_timestamp": null,
        "id": 4221072,
        "type": "product-summary"
    }

Product-Extended

ProductExtendedOptions

Name	Allowed values	Required
display_type	"inline", "popup", "sidebar"	Yes

Voorbeeld Call

{
    "type": "product-extended",
    "options": {
       "display_type": "inline"
    }
}

Responses

Headers

Name	Value
Status code	201
Status message	Created

Voorbeeld resultaat

 {
    "success": true,
    "widget": {
        "shop_id": 7751,
        "options": {
            "display_type": "inline"
        },
        "create_timestamp": "2021-07-22T15:49:40Z",
        "uuid": "48a92ee4-dbaa-4941-8093-925ab2b425d7",
        "last_access_timestamp": null,
        "id": 4221083,
        "type": "product-extended"
    }
}

Embed

Retourneert HTML-sjablonen voor het insluiten van widgets. De “product-samenvatting” en de “product-uitgebreide” widgets gebruiken de “Product HTML-sjabloon. Elke sjabloon bevat verschillende plaatshouder tokens die je moet vervangen om een lopende embed code voor een widget te hebben.

We raden je aan om je eigen integratie te ontwikkelen om elke 24 uur een embed code te ontvangen en een cached kopie lokaal op te slaan. Zo lang de benodigde plaatsvervangers dynamisch worden vervangen, zal er een geüpdatet embed code blijven werken.

Product

URL

Method	URL	Authentication Required
GET	https://www.feedbackcompany.com/includes/widgets/embed-code/v1/product.html	No

Placeholders

Name	Description	Required
{uuid}	The uuid of the widget to embed.	Yes
{prefix}	A unique prefix such as a randomly generated uuid.	Yes
{product_external_id}	The id of the product in your webshop.	Yes
{product_name}	The name of the product in your webshop.	Yes
{product_url}	The url of the product in your webshop.	Yes
{product_image_url}	The url of an image for the product in your webshop.	Yes

Voorbeeld

<!-- Feedback Company Widget (start) --> 
<script type="text/javascript" id="__fbcw__{prefix}{uuid}"> "use strict";!function(){ window.FeedbackCompanyWidgets=window.FeedbackCompanyWidgets||{queue:[], loaders:[]};var options={uuid:"{uuid}",version:"1.2.1",prefix:"{prefix}", urlParams:{product_external_id:"{product_external_id}"}, templateParams:{product_name:"{product_name}",product_url:"{product_url}",product_image_url:"{product_image_url}"}} ;if(void 0===window.FeedbackCompanyWidget){ if(window.FeedbackCompanyWidgets.queue.push(options), !document.getElementById("__fbcw_FeedbackCompanyWidget")){ var scriptTag=document.createElement("script");scriptTag.onload=function(){ if(window.FeedbackCompanyWidget)for(;0<window.FeedbackCompanyWidgets.queue.length;)options=window.FeedbackCompanyWidgets.queue.pop(), window.FeedbackCompanyWidgets.loaders.push(new window.FeedbackCompanyWidgetLoader(options)) }, scriptTag.id="__fbcw_FeedbackCompanyWidget",scriptTag.src="https://www.feedbackcompany.com/includes/widgets/feedback-company-widget.min.js", document.body.appendChild(scriptTag)} }else window.FeedbackCompanyWidgets.loaders.push(new window.FeedbackCompanyWidgetLoader(options)) }(); </script> 
<!-- Feedback Company Widget (end) -->