Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Judge.me Widgets API

Ready-to-render review widget HTML.

Judge.me Widgets API is one of 4 APIs that Judge.me publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Widgets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://judge.me/api/v1.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://judge.me/api/v1
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Judge.me Widgets API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_token (apiToken). An API key is passed in the query as shop_domain (shopDomain). By default, every request must be authenticated.

  • apiToken — Public or private Judge.me API token passed as a query parameter.
  • shopDomain — The store's myshopify.com domain passed as a query parameter.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Widgets 2

Ready-to-render review widget HTML.

GET
/widgets/product_review
Get product review widget HTML
getProductReviewWidget 3 params → 200
GET
/widgets/preview_badge
Get preview badge widget HTML
getPreviewBadgeWidget 3 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is WidgetResponse (1 property). Each schema is shown below with its type and property counts.

WidgetResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

judge-me-widgets-api-openapi.yml Raw ↑

Other APIs Judge.me publishes across the network.

Judge.me Products API
Judge.me Review Requests API
Judge.me Reviews API