1. Utlizzo tramite API JS - Lato client
Introduzione
In questa pagina sono contenute tutte le istruzioni necessarie per l'utilizzo delle API disponibili per gli Widget Feedaty.
Le recensioni autentiche, inserite sul tuo sito, aggiungono credibilità e portano conversioni: con la nostra raccolta di widget puoi mostrare le recensioni nel tuo stile preferito, facendole diventare un elemento aggiuntivo perfettamente integrato con il tuo brand.
Per l'utilizzo delle API JS degli Widget Feedaty© è necessario aggiungere la seguente porzione di codice nella pagina del proprio sito web:
Inclusione della libreria feedaty.js ( Javascript SDK )
La risorsa Javascript:
<script async type="text/javascript" src="https://widget.feedaty.com/v3.0.0/js/2021/merchant_code/feedaty.min.js"></script>
La risorsa javascript dovrà essere inclusa appena dopo la chiusura del body e richiede i seguenti parametri:
- Il paramentro merchant_code indica il Codice Merchant dell'account Feedaty desiderato.Il merchant code è sempre reperibile nella tua area partners personale, nella sezione: Pubblica le recensioni > API
Utilizzo lato client della classe FeedatyWidget per ottenere le recensioni di un prodotto in formato JSON
Per ottenere i dati relativi alle recensioni di un prodotto, è possibile utilizzare la classe FeedatyWidget e la sua funzione getJsonRatings().
Prima di chiamare la funzione, è necessario verificare che la classe FeedatyWidget sia stata caricata correttamente, ad esempio tramite l'evento "FeedatyLoaded" che viene dispatchato dalla stessa classe. In questo modo si evita di incorrere in errori dovuti alla mancanza dell' istanza classe.
La funzione getJsonRatings richiede tre parametri:
SKU
: lo SKU del prodotto di cui si vogliono ottenere le recensioni.LANG
: il filtro lingua che specifica la lingua delle recensioni da recuperare. I valori accettati sono: null, all, it-IT, fr-FR, de-DE, es-ES, en-US.CALLBACK
: la funzione di callback che gestisce i dati restituiti dalla funzione getJsonRatings. Questa funzione consente di utilizzare i dati ottenuti in base alle proprie esigenze.
Esempio di utilizzo:
FeedatyWidget.getJsonRatings('SKU123', 'it-IT', function(data) {
// Gestione dei dati restituiti dalla funzione getJsonRatings
console.log(data);
});
È possibile consultare un esempio di utilizzo della funzione alla URL: https://widget.Feedaty.com/v3.0.0/test/snippets/ratings_api.html.
1. Utlizzo tramite API Lato server
Per chiamare la API basterà fare una richiesta GET tramite cURL all'endpoint:
http://widget.feedaty.com/v3.0.0/ratings/merchant_code/product/all/SKU
Dove:
- L'endpoint della API è
http://widget.feedaty.com/v3.0.0/ratings/merchant_code/product/
/all/
sarà il filtro lingua delle review, con cui potranno filtrare i count e la media dei rating in base alla culture (all e null nessun filtro selezionato, IT-it ad esempio per solo review in italiano)/SKU/
sarà lo SKU (o meglio quelle che riceviamo noi come SKU) del prodotto per cui desiderano i dati
La risposta sarà un oggetto JSON contenente i dati del merchant selezionato compreso l'oggetto Product con i dati del prodotto selezionato. Ad esempio, per l'AvgRating e i RatingCount del prodotto si dovranno prendere il campo data.Product.AvgRating
e data.Product.RatingCount
.
Esempio in PHP
Utilizzando la libreria cURL di PHP, la chiamata alla API può essere effettuata nel seguente modo:
<?php
$merchant_code = 'MERCHANTCODE';
$sku = 'SKU';
$url = "http://widget.feedaty.com/v3.0.0/ratings/{$merchant_code}/product/all/{$sku}";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$headers = array();
$headers[] = "Content-Type: application/json";
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
}
curl_close($ch);
$response = json_decode($result);
// qui si possono elaborare i dati della risposta come necessario
?>