Overview
This guide outlines how to use RaveCapture's manual integration tools and API documentation to collect and display reviews, synchronize data, and enhance your website with custom review widgets. It is intended for both technical users (developers) and non-technical users (merchants) who want to understand when and how to use these resources effectively.
Why Use Manual Integration or the API?
RaveCapture provides two flexible integration paths for merchants who are not using a native eCommerce integration (like Shopify or BigCommerce), or who want additional control:
Manual Integration: For embedding widgets and review content on a custom-built website.
API Access: For programmatically submitting orders, fetching reviews, syncing products, and more.
Use these tools when:
You have a custom eCommerce platform.
You want to automate review collection outside of built-in platform support.
You’re embedding reviews into a fully custom storefront, app, or CMS.
You need advanced developer access to review or product data.
Part 1: Manual Widget Integration
Manual integration allows you to display review content on your product pages using our JavaScript embed and custom widget code. This is ideal for developers managing headless sites or non-traditional storefronts.
Required Setup
1. Add RaveCapture JavaScript to <head>
<script>trustspot_key = 'YOUR-RAVECAPTURE-KEY';</script>
<script async src="https://app.ravecapture.com/assets/js/trustspot_product_reviews.js"></script>
2. Insert Product Review Widget Place this widget on your product page where you want reviews to appear:
<div class="trustspot trustspot-main-widget"
data-product-sku="YOUR_PRODUCT_SKU_HERE"
data-name="YOUR_PRODUCT_NAME_HERE"
data-url="YOUR_PRODUCT_URL_HERE"
data-image-url="YOUR_PRODUCT_IMAGE_URL_HERE"
data-description="YOUR_PRODUCT_DESCRIPTION_HERE"
data-rc-product-price="YOUR_PRODUCT_PRICE_HERE"
data-rc-product-brand="YOUR_PRODUCT_BRAND_HERE"
data-rc-product-mpn="YOUR_PRODUCT_MPN_HERE"
data-rc-product-gtin="YOUR_PRODUCT_GTIN_HERE"
data-rc-product-syndication-id="YOUR_PRODUCT_SYNDICATION_ID_HERE"
data-rc-product-price-symbol="YOUR_PRODUCT_PRICE_SYMBOL_HERE"></div>
Only data-product-sku is required for basic widget functionality. We support the following currency symbols: $, € and £. If not provided, then the default one will be applied ($).
However, we strongly recommend populating as many fields as possible, as this data feeds directly into your Product Library—automatically enriching your product records with price, image, brand, and syndication information. Replace all placeholder values dynamically from your product page’s backend schema to ensure data consistency across your store.
3. Optional: Add Inline Stars For top-of-page review stars:
<div class="trustspot-inline-product" data-product-sku="YOUR_PRODUCT_SKU"></div>
4. Optional: Add Category Stars (for PLP grids)
<div class="trustspot-inline-category" data-product-sku="YOUR_PRODUCT_SKU"></div>
To style widget, visit: Display Widgets > Product Review Widget.
Part 2: API Overview & Access
RaveCapture’s API suite enables developers to:
Submit order data to trigger review requests.
Pull review content for custom displays.
Create or update products.
Post product reviews from external systems.
Access Requirements
All API access begins at the Power Plan. You’ll need:
Merchant ID
API Key
API Secret Key
You can find these in-app: Integrations > API
Authentication
All POST requests require an HMAC signature using your API Secret. See each endpoint's documentation for full auth examples.
API Endpoint Categories
🔹 Company Review APIs (2 endpoints)
1. Company Review Request Submission API
Used to trigger a Company Review request after an order.
Inputs: Customer name, email, order ID.
Method: POST
2. Company Review Details API
Fetch Company Reviews for display.
Filters: Date range, rating, location
Method: GET
🔸 Product Review & Product Data APIs (6 endpoints)
3. Order Submission API for Product Review Requests
Triggers product review requests by submitting order data.
Inputs: Customer info, order ID, list of product SKUs
Method: POST
4. Create/Update Products API
Used to create or modify product records in your Product Library.
Inputs: SKU, name, description, image URL, price, etc.
Method: POST
5. Product Review (Post New Review) API
Pushes a product review from an external system into RaveCapture.
Inputs: Product ID, review content, rating, customer info
Method: POST
6. Product Review (GET) API – Summary Data
Fetches review counts and average rating for a product.
Useful for custom inline star ratings.
Method: GET
7. Product Reviews (GET) API – Full Content
Fetches full review text, media, rating, timestamp, etc.
Supports filtering, pagination.
Method: GET
8. Product Review Details API
Returns the full detail of a single product review.
Inputs: Review ID
Method: GET
Final Notes & Best Practices
Review the [API Documentation PDFs] in your RaveCapture dashboard under Settings > Integrations.
All API endpoints are subject to rate limits (documented per endpoint).
If using dynamic coupon logic or Experience Surveys, consult those specific articles for post-review workflows.
Need Help?
If you need help implementing the manual integration or configuring API access, contact our support team via live chat or email at support@ravecapture.com.