Creëer

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

De “main” widget is de meest gebruikte, het toont de gemiddelde score van de shop, sterren en het aantal reviews. Optioneel toont het ook 1 of 2 willekeurige reviews.
De “bar” widget toont de gemiddelde score, sterren en het aantal review in een compacte balk die gemakkelijk boven de navigatie of tussen twee secties van de website kan worden geplaatst. Deze widget vult zich tot 100% van de container op waarin hij in is geplaatst.

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.

Name	Allowed values	Required
type	"main","bar","sticky"	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
main	(A "MainOptions" Object	Yes
bar	-	No
sticky	-	No

MainOption

Name	Allowed values	Required
size	"big","small"	Yes
amount_of_reviews	0, 1, 2	Yes

Voorbeeld

 {
    "type": "main",
    "options": {
       "size": "small",
       "amount_of_reviews": 2
    }
}

Responses

Headers

Name	Value
Status code	201
Status message	Created

Voorbeeld

 {
  "success": true;
  "widget": {
    "shop_id": 1234,
    "options: {
      "amount_of_reviews": 2,
      "size": "small"
    },
    "create_timestamp: "2018-04-01T00:00:00z",
    "uuid": "56c7e115-2e22-46a5-b0c2-fcc386b4ad6",
    "last_access_timestamp": null,
    "id": 5678,
    "type": "main"
  }
}

Embed

Retourneert HTML-sjablonen voor het insluiten van widgets. De ‘Main” en “Bar” widgets gebruiken de “Default HMTL-sjabloon". De stijl van het widget wordt bepaalde door het UUID dat in het widget script wordt opgenomen.

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.

Default

URL

Name	Value
Method	GET
Endpoint	https://www.feedbackcompany.com/includes/widgets/embed-code/v1/default.html

Placeholders

Name	Description	Required
{uuid}	The uuid of the widget to embed.	Yes
{prefix}	A unique prefix such as a randomly generated uuid	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:""};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) -->