Interactive cryptographic signature engine & payload inspector for verified reviews
Ensure the Digest Algorithm selected matches your Yotpo account settings (HMAC or SHA256).
Signature generated!
Please fill in all required fields (App Key, Secret Key, Reviewer Email, and Product ID) to calculate the authentication signature.
The exact message concatenated before passing into the cryptographic function
verified_buyer.
Select an implementation strategy to view code templates and parameter specifications
Using this implementation method, you can generate a unique URL to include in customer emails or pages on your site. The URL contains your computed signature and parameters to direct reviewers to a Yotpo-hosted landing page. Reviews submitted via this page receive a Verified Buyer or Verified Reviewer badge automatically.
https://landing-pages.yotpo.com/base/#/review?appkey={{appKey}}&sku={{productId}}&product_title=USBthingy&product_url=http:%2F%2Fgkshops.com%2FBigUSBthingy.html&display_name=Arthur&email={{reviewerEmail}}&signature={{signature}}&time_stamp={{timestamp}}&reviewer_type={{reviewerType}}&review_title_required=true
| Parameter | Description |
|---|---|
appkey
|
Your Yotpo account API key. |
sku
|
The SKU (stock-keeping unit) of the product. |
product_title
|
The display name of the product. |
product_description
|
The description of the product. |
product_url
|
The URL of the product on your storefront. |
display_name
|
Reviewer display name. |
email
|
The verified buyer or verified reviewer email address. |
signature
|
The hexadecimal representation of the computed authentication code, using HMAC or SHA256. The secret is your Yotpo account secret. |
time_stamp
|
Unix epoch timestamp in milliseconds. |
reviewer_type
|
The reviewer badge type. Possible values:
verified_buyer or
verified_reviewer.
|
review_title_required
|
Boolean parameter (true or
false) declaring whether the review title
field is mandatory on the landing page.
|
Using this method, reviews created via your on-site Reviews Widget or Reviews Tab automatically receive a Verified Buyer or Verified Reviewer badge based on the signed data element present in the DOM.
"yotpo-signed-data" and must be
embedded directly in the page DOM alongside the widget.
<div class="yotpo-signed-data"
data-user-name="John Doe"
data-user-email="{{reviewerEmail}}"
data-signature="{{signature}}"
data-reviewer-type="{{reviewerType}}"
data-time-stamp="{{timestamp}}"
></div>| Attribute | Description | Required |
|---|---|---|
data-user-name
|
The full name of the verified buyer / reviewer. | Required |
data-user-email
|
The email address of the verified reviewer. | Required |
data-reviewer-type
|
Reviewer badge type: verified_buyer or
verified_reviewer.
|
Required |
data-time-stamp
|
Unix timestamp in milliseconds. | Required |
data-signature
|
Computed cryptographic signature hexadecimal digest. | Required |
data-reviewer-badge
|
Custom badge name (only used with Customized Badge feature). | Optional |
Using this method, reviews created programmatically using the Creating Reviews (Asynchronous) endpoint will receive a Verified Buyer or Verified Reviewer badge based on the provided signature payload.
curl --location 'https://api.yotpo.com/v1/widget/reviews' \
--header 'Content-Type: application/json' \
--data-raw '{
"appkey": "{{appKey}}",
"domain": "http://www.shop.com",
"sku": "{{productId}}",
"product_title": "Phone",
"product_url": "http://www.shop.com/phone.html",
"product_image_url": "http://www.shop.com/phone.jpg",
"display_name": "John Smith",
"email": "{{reviewerEmail}}",
"review_content": "It’s really good",
"review_title": "Great Phone",
"review_score": 5,
"signature": "{{signature}}",
"time_stamp": "{{timestamp}}",
"reviewer_type": "{{reviewerType}}"
}'| Parameter | Description | Required |
|---|---|---|
appkey
|
Your Yotpo account API key. | Required |
sku
|
The unique ID of the product (or
'yotpo_site_reviews' for site review).
|
Required |
product_title
|
The title of the product. | Required |
product_url
|
The product page URL. | Required |
display_name
|
The reviewer's name. | Required |
email
|
The reviewer's email address. | Required |
review_content
|
The text content of the review. | Required |
review_title
|
The title of the review. | Required |
review_score
|
The numeric review score (e.g. 1-5). | Required |
signature
|
Hexadecimal HMAC or SHA256 cryptographic signature. Must be in lowercase characters. | Required |
time_stamp
|
Unix timestamp in milliseconds. | Required |
reviewer_type
|
Reviewer badge: verified_buyer or
verified_reviewer.
|
Required |
domain
|
The account domain. | Optional |
product_description
|
The description of the product. | Optional |
product_image_url
|
The URL of the product image. | Optional |
image_urls
|
Images submitted with the review. | Optional |
submission_time_stamp
|
Creation date if not today (up to 7 days in the past). | Optional |