Create a new Studio session
Generates an opaque session token for the Studio iframe on WooCommerce, custom storefronts, and Shopify storefronts that call through the App Proxy. No unauthenticated access. API key never leaves the server.
x-api-key header, to open one
visit to the embedded editor; a signed storefront request opens one for the store
it is signed for. The response carries the opaque session token the editor is
opened with, the message_session_id your page matches every editor message
against, and the one time bootstrap_secret that completes the handshake. Your
key stays on your server, in neither the token nor the response. mockup_type
picks the editor, session_kind picks the job, and allowed_origin names the
one origin allowed to embed the session.
expires_in is an idle window rather than a countdown from creation. It
restarts while the session is in use, so an editor a shopper is still working
in stays open.Authorizations
API key with sm_ prefix. Get your key at https://sudomock.com/dashboard/api-keys
Body
Which editor the session opens, psd or 2d.
psd, 2d What the session is for, setup or customize.
setup, customize UUID of the mockup to customize
"c315f78f-d2c7-4541-b240-a9372842de94"
Product ID from the platform
255"8342019283"
Variant ID from the platform
255"44912837465"
HTTPS origin of the page that embeds the editor.
2048"https://your-store.example.com"
Optional session-only Studio config override. Not persisted.
Your own routing identifier for the action this session completes.
1 - 64^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$"add-to-cart"
- StudioArtworkInput · object[]
- StudioArtworkInput · object
Response
Successful Response
Which editor this session opens, psd or 2d.
psd, 2d Opaque token the editor is opened with.
"sess_xQ8pM2vK7nR4tB1yH6zJ3wL5sD9fG0aC2eN8uV4iT7o"
Seconds the session stays valid while it sits idle.
900
Identifier your page matches every editor message against.
"7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52"
One-time secret your page sends to complete the handshake.
"wAKBqgAce_HWV01uenTwEPrczjPkIt9xH0BSjQ1S68A"
True when the session was created.