This guide shows you how to integrate and use our API to enhance your experience with Judge.me.
API documentation
You can access our API documentation following the OpenAPI specification at https://judge.me/api. This documentation is presented in YAML format, and you can find the original YAML file here.
Server endpoint
The primary server endpoint for our API is https://judge.me/api/v1.
API endpoint example
For instance, to access widget information for product reviews, you can use this endpoint: https://judge.me/api/v1/widgets/product_review.
Accessing credentials
To use our API, you'll need two essential credentials:
shop_domain: This identifier can be retrieved from your Judge.me account settings under "Integrations" > "Developers" > "Judge.me API."
api_token: There are two types of api_tokens:
Private Token: This token grants read/write access to your data and should be exclusively used on the server-side for enhanced security.
Public Token: The public token is suitable for making GET requests to our widget API. It's designed for use in public JavaScript environments.
If you need help using our API, contact our team at [email protected]. We're available to help 24/7!