Welcome to our guide for tech partners looking to integrate with Judge.me. This guide is here to help you with clear steps and best practices for a successful integration. It benefits both your app and our platform.
By following these guidelines, you'll unlock the potential to offer enhanced experiences to our shared users.
Important Note
To enhance security, it's strongly advised to opt for the OAuth approach when creating integrations.
Access only the data that's essential for official verification and integration promotion.
Please note that Judge.me necessitates testing and verification before widespread promotion.
Certain integrations are exclusively available on Judge.me's Awesome plan and specific partner plans.
Step 1: Start with the basics
Begin by exploring our informative getting started guides.
Use the comprehensive table below to find your integration's category.
Click the relevant category link for detailed guidelines.
Categories | How to build integration with Judge.me |
Category 1:
| Use Judge.me’s cache server (recommended) or widget API. |
Category 2:
| Create webhook to pull information from Judge.me. |
Category 3: SEO | Add Judge.me’s code to your product’s snippet. |
Category 4: Shipment tracking | Update delivery status to Shopify, no need to get any data from Judge.me. |
Category 5: Translation | Provide translations on the fly. |
Should your role as an e-commerce platform, tech app, or agency partner fall outside the categories listed above, we encourage you to reach out to us at [email protected] for tailored assistance.
Step 2: Develop your integration
Read guidelines for each integration categories and API documentation.
If you have technical questions, please email [email protected] and include relevant screenshots or screencasts if needed.
Seeking a Development Store?
For Shopify app providers: Create a Shopify development store and get a free upgrade to our Awesome plan.
For WooCommerce and BigCommerce users: Automatically join the free Awesome plan.
Step 3: Submit for technical review
After you've finished your integration, it's time for a technical review:
Fill out the technical review form.
Include your testing credentials.
Create a comprehensive demo video.
Ensure the video contains clear, step-by-step instructions for smooth testing.
Step 4: Elevate through promotion
After testing and approval, we team up for co-marketing efforts.
We're excited to start co-marketing activities to make the integrated solution even more impactful.
Additional details can be found here, providing more information into the collaborative possibilities ahead.
Integration tips for specific application types
In the sections that follow, we offer valuable tips and address common inquiries tailored to distinct app types:
1. Product recommendations, upselling, search apps, and page builders
To show Judge.me widget info, like ratings and reviews, on your store's front end, you have two options:
Request to Our Cache Server (Recommended for Awesome paid stores):
Loads multiple widgets in one request.
Widgets update almost instantly, with just a few minutes of delay.
Use Widget API via cdn.judge.me (For Free stores):
Suitable for small to medium-sized stores.
Widgets may take up to 20 minutes to update.
2. Rewards, marketing automations, email marketing, and storefront notifications apps
To use our review data, set up webhooks on your end to get data from Judge.me.
To build this, follow our OAuth process and request only the permissions you need from users.
Usually, you'll need read_reviews and read_reviewers permissions. If you need more, our QA team will check to make sure it fits your needs.
Common application scenarios include:
Reward Apps: You can connect and set up rewards in partner apps. When a new review meets the criteria, we give rewards like points or coupon codes to customers.
Marketing Automation Apps: Reviews submitted trigger actions in partner apps, letting users do things in other apps.
Email Marketing Apps: New reviews create events in partner apps, sending review info as special details. This helps in grouping customers for email campaigns.
Storefront Notification Apps: Submitted reviews trigger events in partner apps, showing review content in store notifications.
3. SEO apps
If you want to showcase product reviews in search results, please add this code to your product snippets:
{%- if product.metafields.judgeme -%}
"@id": {{ canonical_url | append: '#product' | json }},
{%- endif -%}
This code adds an "@id" to your JSON-LD script. Our app recognizes it and combines your content with our AggregateRating. This link connects your product snippets with our review snippets, so ratings show up in search results.
4. Shipment tracking apps
For shipment tracking apps, we watch for the "Delivered" status in Shopify.
If merchants use the Delivery-based requests feature in Judge.me, we schedule review requests upon order delivery, not just upon fulfillment.
5. Translation apps
Our translations for widget texts have been integrated with Shopify. Integrating with a translation app is often unnecessary, especially for translation within Shopify's secondary languages through translatable resources.
However, exceptions apply to on-the-fly page content translations like Weglot and translations beyond Shopify's secondary languages.
Caution
Avoid modifying or translating Shopify metafields with "judgeme" in their names.
These metafields contain HTML code that can unintentionally disrupt your store's pages.
Be aware that metafield content may change with system updates.
If changes occur, remember to update any translations accordingly.
If you need help integrating with Judge.me, contact our team at [email protected]. We're available to help 24/7!