Meisei

    Boot

    These endpoints are called from a shopper's browser, so they take your publishable key rather than a secret one. Anything specific to one customer also takes a signed email and timestamp. Identifying the customer explains how to produce the signature.

    To call them from your own server instead, send a secret key as a bearer token and leave apiPublishableKey out. See Calling the widget API from a server.

    GET /widgets/boot

    Get everything a page's widgets read before they draw in one request: ratings, reviews, photos, the loyalty program, the points a purchase earns and the theme stylesheet. Each read is answered exactly as its own endpoint would answer it, and one that fails does not fail the rest. The embed script and the React widgets use this so a page costs one request rather than one per widget. A guest's request is the same for every shopper on that page, so it is cached at the edge.

    Query parameters

    apiPublishableKeystring

    Your organization's publishable key, from Settings, API keys. Leave it out when the request carries a secret key as a bearer token instead, which is how a server calls these endpoints.

    readsstringrequired

    The reads to answer, comma-separated, each one the path under /widgets and its own URL-encoded query, such as rating?productSlugs=mug%2Cplate. Up to 20. The paths are rating, reviews, reviews/media, loyalty, loyalty/earnable, theme.css, each with the query parameters its own endpoint takes, except a shopper's signature (which goes on this request instead), a voter token and a preview token.

    customerEmailstring (email)

    The signed-in shopper's address, applied to the reviews, loyalty and loyalty/earnable reads. Leave it out for a guest, which is the request the edge can share between shoppers.

    timestampstring
    signaturestring
    Request
    curl \
  "https://your-store.meisei.app/api/widgets/boot?apiPublishableKey=pk_YOUR_PUBLISHABLE_KEY&reads=string"
    Response
    {
  "reads": [
    {
      "read": "string",
      "status": 0,
      "body": "..."
    }
  ]
}