Documentation
Posiziona i tuoi widget di recensioni su qualsiasi negozio. Una sola riga di codice da incollare, senza alcun conflitto con il tuo tema.
Save time with the guided setup
Log in to walk through the installation step by step: pre-filled key in every snippet, live widget customization, catalog / review imports — each step is validated automatically.
Widgets
Choose your platform
The whole guide adapts: steps, code snippet, documentation links and troubleshooting.
Step 0 — recommended
Accedi al tuo account OpenReviews e gli snippet qui sotto si compileranno con la tua chiave widget. Altrimenti sostituisci la chiave di esempio pk_live_VOTRE_CLE con quella mostrata nella tua dashboard.
Follow the steps — Shopify
Check each step off as you go — your progress shows at the top and we take you straight to the next one.
In the Shopify App Store, search for “OpenReviews” and click Install. Grant access to your store when Shopify asks.
In the Shopify admin: Online Store → Themes → “Customize” button on your active theme.
At the top of the editor, open the “Products → Default product” template. Click “Add block” in the section you want and pick the OpenReviews block: Star rating, Reviews, or Summary.
Click “Save” in the top right corner. That's it: the key is connected automatically by the app, there is no code to paste.
If you prefer editing the theme by hand instead of using blocks, paste this snippet in your product template (Online Store → Themes → ⋯ → Edit code). The key comes from the metafield set automatically by the app.
<div id="or-reviews" style="display:block">
<a href="https://openreviews.io/r/{{ product.id }}" data-or-attribution style="display:inline-block;font-size:12px;opacity:.7;text-decoration:none">Avis vérifiés par OpenReviews</a>
<script src="https://api.openreviews.io/augur.js"
data-tenant="{{ shop.metafields.openreviews.widget_key.value }}"
data-gtin="{{ product.id }}"
data-variant="grid"
data-target="#or-reviews"
defer></script>
</div>Official documentation
In 30 seconds
The widget installs with a single <script defer>. No dependency to load, nothing to build on the store side.
The widget reads the page's product identifier on its own (Shopify, JSON-LD, OpenGraph, WooCommerce, PrestaShop). data-gtin is optional.
Everything renders in a Shadow DOM: your theme's CSS doesn't affect the widget, and vice versa. SEO markup (JSON-LD) injected automatically.
Patience
Alcuni passaggi richiedono un po’ di tempo: è normale che un widget appena installato non mostri subito tutto. Ecco i tempi da conoscere per non preoccuparsi.
The summary (score, strengths / weaknesses) appears from 5 OpenReviews reviews (or as soon as an external aggregate exists). Below that, the widget shows “Reviews being analyzed”.
La sintesi si aggiorna al massimo una volta ogni 6 ore. Il raggiungimento di 5 recensioni, o un afflusso di recensioni nuove, la aggiorna prima.
Import and product matching take a few minutes. A product without any review doesn't exist in the catalog yet: it is created when its first review arrives (the widget hides gracefully in the meantime).
Dopo un aggiornamento, la nuova versione del widget può impiegare qualche minuto ad arrivare sul tuo negozio. Un ricaricamento forzato (Ctrl/Cmd + Maiusc + R) la mostra subito.
Reference
Pick the rendering via the data-variant attribute. You can place several widgets on the same page (e.g. the star rating under the title + the review grid further down), one script per block.
| Variant | Rendering |
|---|---|
main | Summary (score, strengths / weaknesses) + chat button. |
grid | Summary + chat, then text reviews in a grid (clickable photos / videos). |
rows | Summary + chat, then text reviews in a full-width list. |
carousel | Score banner + horizontal review carousel (arrows, dots, swipe, gentle autoplay). |
stars | Compact star rating (stars + score + review count), ideal under the product title. |
| Attribute | Required | Description |
|---|---|---|
| data-tenant | ✓ | Public widget key (pk_live_…). |
| data-variant | — | main, grid, rows, carousel or stars. Default: main. |
| data-gtin | — | Product identifier. Absent → automatic detection; present → takes priority. |
| data-target | — | CSS selector of the mount container. Otherwise, inserted right after the script. |
| data-locale | — | Display locale (date / number formats). Default: fr. |
| data-product-name | — | Product name for SEO markup (JSON-LD). Default: page title. |
| data-seo | — | Set to off to disable JSON-LD injection. |
| data-size | — | stars variant: star size — sm, md or lg. Default: md. |
| data-clickable | — | stars variant: set to off to remove the click-through to reviews (non-interactive rendering). |
| data-count | — | stars variant: set to off to hide the review count. |
| data-rating | — | stars variant: set to off to hide the numeric score. |
data-gtin is optional. Add it only to force a precise value (page without structured data, or a specific identifier). It then takes priority over automatic detection. Use your platform's product ID (most reliable), or the GTIN/EAN barcode, or the SKU.
<script src="https://api.openreviews.io/augur.js"
data-tenant="pk_live_VOTRE_CLE"
data-variant="carousel"
data-gtin="IDENTIFIANT_DU_PRODUIT"
defer></script>Troubleshooting
Shopify specific
| Symptom | Probable cause / solution |
|---|---|
| The OpenReviews block doesn't show in the editor | Check the app is installed, then in the theme editor open Theme settings → App embeds and enable OpenReviews. |
| The widget stays invisible on the store | Check the block is placed in the Product template (not just previewed), save, then reload the page with Ctrl/Cmd + Shift + R. |
All platforms
| Symptom | Probable cause / solution |
|---|---|
| Nothing shows up | data-tenant is empty (the console shows “[Augur] data-tenant est requis”), or no product identifier was detected. Add an explicit data-gtin. |
| Empty widget / “product not found” | The data-gtin value doesn't match any known identifier of the product in OpenReviews. Try your platform's product ID, or check that the barcode / SKU is synced. |
| The review block doesn't appear (grid / rows) | The product has no text reviews yet — normal behavior: the summary and stars remain visible. |
| Widget key not found | Log in above, or retrieve it in the OpenReviews dashboard → Widgets → Install. |
Once your widgets are in place, everything runs on its own. Track your reviews and syndication from your dashboard.
Open my dashboard