Our technical documentation can be found at https://judge.me/api. Our API documentation follows OpenAPI spec, so you can find the original YAML for the doc here.

The server endpoint for API is https://judge.me/api/v1

For example, https://judge.me/api/v1/widgets/product_review.

You can retrieve your shop_domain and api_token value from Judge.me Settings > Integrations > Developers > Judge.me API.

Please note that there are 2 types of api_token:

  • The private token has read/write access to your data so it should only be used on the server side.
  • The public token can only GET widget API so it is suitable to be called in public javascript.