Public embeds and API integration boundaries
Understand the supported ShopFlare widget integration surface without relying on private dashboard or administrative endpoints.
On this page
Use the generated embed contractDo not treat observed requests as a public SDKAsk about a custom integrationUse the generated embed contract
The widget installation area is the supported starting point for customer-facing integration. Copy the current generated snippet and follow the selected method's instructions. Keep a record of where it is installed so it can be updated or removed cleanly.
Do not treat observed requests as a public SDK
Requests visible in developer tools may be internal implementation details and can require context not represented in a copied request. This documentation does not promise a general-purpose public REST API, stable private endpoints, or administrator access through widget identifiers.
Ask about a custom integration
Explain the intended workflow, data types, and access boundaries to support. Agree on an explicitly supported interface before building an integration. Keep private credentials on the server and never place a privileged token in customer-facing JavaScript.
Still need help?
Tell us what you expected and what happened.