Installation & integrations

Widgets

Install the widgets, step by step

Choose your platform

The whole guide adapts: steps, code snippet, documentation links and troubleshooting.

Step 0 — recommended

You are not logged in

Log in to your OpenReviews account to automatically fill the snippets below with your real widget key and tenant ID. Otherwise, simply replace pk_live_VOTRE_CLE with the key shown in your 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.

0/5

Step 1 of 5
Install the OpenReviews app
In the Shopify App Store, search for “OpenReviews” and click Install. Grant access to your store when Shopify asks.
Step 2 of 5
Open the theme editor
In the Shopify admin: Online Store → Themes → “Customize” button on your active theme.
Step 3 of 5
Add a review block on the product page
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.
Step 4 of 5
Save
Click “Save” in the top right corner. That's it: the key is connected automatically by the app, there is no code to paste.

Step 5 of 5

Optional — manual method (code)

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>

Product identifier — The app automatically fills {{ product.id }}: each product page shows its own reviews, nothing to configure.

Official documentation

Shopify — Extend your theme with apps Shopify Dev — Theme app extensions

In 30 seconds

How the widget works

A single tag

The widget installs with a single <script defer>. No dependency to load, nothing to build on the store side.

Automatic product detection

The widget reads the page's product identifier on its own (Shopify, JSON-LD, OpenGraph, WooCommerce, PrestaShop). data-gtin is optional.

Isolated rendering, zero conflict

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

How long before things show up?

Some features are asynchronous: it's normal for a freshly installed widget not to display everything immediately. Here are the delays to know about so you don't worry.

Summary

Minimum 5 reviews

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”.

Summary

Recomputed every 6 h

The summary is recomputed at most once every 6 hours (debounce). Crossing the 5-review threshold or strong growth triggers an early recompute.

Ingestion

Asynchronous processing

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).

Deployment

Script propagation

After an update, the new version of augur.js can take a few minutes to propagate on the CDN. A hard reload (Ctrl/Cmd + Shift + R) shows it right away.

Reference

Variants, attributes & advanced options

Widget variants

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.

data-* attribute reference

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.

Force a product identifier (data-gtin) — advanced

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

Nothing showing up?

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

Install OpenReviews in a few minutes