LoyumiDeveloper docsOpen Sandbox
DOCUMENTATION · BETA

Learn the workflow, then open the authenticated builder.

This public route documents Widget Studio. Configuration, validation, and publishing happen only in the authenticated merchant console.

Developer docs · no accountSandbox firstAPI 1.13.0 · 121 operations · 106 paths
Open authenticated Widget StudioRead the workflow
DOCUMENTATION · BETA

Learn the publish flow here. Use the real builder in the console.

This public route is documentation only: it does not create a draft, validate an origin, publish a deployment, or display customer data. Those actions happen after authentication in the merchant console.

Available Beta
  • Member balance, tier progress, reward catalog, and activity history
  • Edit mode plus clearly labeled UI-state preview tooling
  • Guest, personalized, loading, empty, error, and offline preview scenarios
  • Responsive ordering, visibility, and supported theme tokens
  • Blocking contrast and publishability checks
  • Published wdg_… deployment and copyable embed
  • Stable downloadable React wrapper for published deployments
Not published
  • Public package-registry distribution for the downloadable SDK, CLI, React, iOS, or Android clients
  • Arbitrary executable components
  • Unrestricted CSS or private Shadow DOM access
  • Browser-held API secrets
  • Customer identity inferred from browser input
  • A live native merchant gateway or physical-device proof claim
BUILDER WORKFLOW

Defaults first. Granular control when needed.

  1. 1
    Choose a starting layout

    Start with the recommended four-family customer experience or select only the surfaces the program needs.

  2. 2
    Match the brand

    Choose a safe preset, then adjust the published accent, background, surface, text, radius, and minimum-height tokens.

  3. 3
    Arrange

    Move widget families with keyboard-accessible controls and set responsive visibility in Edit mode.

  4. 4
    Test the exact UI

    Switch to Exact runtime and inspect guest, personalized, loading, empty, error, offline, narrow, and wide scenarios. These are clearly labeled UI simulations, make no production API request, change no customer record, and use the same renderer that ships.

  5. 5
    Secure

    Choose the durable deployment, preserve its complete origin list and program, then explicitly confirm any destructive security change.

  6. 6
    Publish and verify

    Publish the deployment, copy the versioned embed, open it on an allowed Sandbox origin, and confirm the ready, loaded, action, and error events.

PUBLISH

The output is small and inspectable.

Publishing creates a wdg_… deployment for the versioned Web Widget v1 loader. Add it to the custom element and keep the major version in the script URL.

  • Guest catalog: publish and paste the embed.
  • Personalized mode: also add your same-origin session-endpoint.
  • Production: the program must be published and the production environment must pass its readiness gate.
  • Each immutable version captures the program, name, complete origin allowlist, redemption policy, and layout.
  • Rollback restores that complete version; a later publish always receives a new version number.
  • Changes are not considered verified until the published widget loads on an allowed origin.
Published guest embed
<script async src="https://docs.loyumi.com/widgets/v1/loyumi.js"></script>
<loyumi-rewards deployment="wdg_…">
  <a href="/account/rewards">View rewards</a>
</loyumi-rewards>
QUALITY GATES

A pretty preview is not enough.

01

Every configured origin is an exact scheme, host, and port match

02

Guest mode exposes no customer balance, tier, activity, or redemption

03

Signed sessions expire within 10 minutes and contain only required capabilities

04

Text, focus, controls, and theme colors meet accessibility targets

05

Loading, empty, error, offline, and success states are verified

06

No API secret or customer record is stored in the widget configuration

HONEST HANDOFF

What Studio deliberately does not hide.

  • Widget Studio does not ingest purchases or returns; use a merchant-built integration, an installed connector, or the HTTPS JSON API. SDK 2.3.0 adds synthetic Shopify and Klaviyo mapping conformance, not a native connector or hosted sync.
  • Redemption is a server-authorized value movement, not a browser event callback; coupon and third-party reward fulfillment remain connector responsibilities.
  • Web Widget v1 and Widget Studio remain Beta; validate them in Sandbox and monitor lifecycle errors before broad rollout.
  • The TypeScript SDK 2.3.0 and CLI 1.5.1 are stable downloads; iOS and Android remain stable 1.1.0 source packages; React remains stable 1.0.0. Native UI Kit 1.0.0-beta.1 remains Beta. Public package-registry distribution, provider connectivity, a live native merchant gateway, and physical-device validation are not claimed.
  • The immutable v1.0.0 widget artifact and SRI freeze only the merchant-page loader. The hosted iframe remains on the compatible v1 runtime channel.