Prerequisites
Before you start, collect:- your workspace publishable key
- a product reference
- the product page language
Authenticate requests
Send your publishable key as a bearer token:Render a Rich Snippet
- Call the endpoint before returning the product page.
- Pass a Cevoid product ID, variant ID, external product reference, or product slug as
productRef. - Pass the page language. Pass a market when you know it, or send the product page URL so Cevoid can select the market.
- Insert
htmlwhere the rating should appear. - Serialize
jsonLdinto the same initial HTML response.
productRef=auto only when you also send the product page URL in the referer query parameter or Referer header. A stable product reference is more predictable for server integrations.
Keep one rendering snapshot
Usehtml and jsonLd from the same response so the visible rating matches the structured data.
Keep data-cevoid-rich-snippet="ssr" on the JSON-LD script so Cevoid does not add duplicate structured data when its client script loads.
404, omit both outputs. No published rating is available for the request.