API
Styles and Stickers
List style sets, render previews and final SVGs, manage authored canvases, and read what a style or sticker has earned.
A style set is the visual layer. Each smart product links to exactly one, and rendering is deterministic for a given style and content - so a render is safe to cache.
{id} is the style set id throughout. A canvas id names a slot and an orientation and
never a size; read /api/styles/{id}/canvases for real width and height.
Note the shape: page renders live under /api/styles/pages/* and tickets under
/api/styles/tickets/*. There is no /api/style-sets/{id}/render - the only /api/style-sets
routes are the two earnings reads below.
Style sets
| Method | Path | Auth | Purpose |
|---|---|---|---|
GET | /api/styles/pages | app key | List page style sets. |
POST | /api/styles/pages | app key + user, entitlement | Create a style set. Needs CREATE_ASSETS. |
DELETE | /api/styles/pages/{id} | app key + user, entitlement | Delete a style set. Needs CREATE_ASSETS or MANAGE_TEMPLATES. |
GET | /api/styles/pages/{id} | app key | One style set. |
PUT | /api/styles/pages/{id} | app key + user, entitlement | Update a style set. Needs CREATE_ASSETS or MANAGE_TEMPLATES. |
POST | /api/styles/pages/{id}/styles | app key + user, entitlement | Add an authored canvas to a style set. Needs CREATE_ASSETS. |
DELETE | /api/styles/{id} | app key + user, entitlement | Delete one authored canvas. Needs CREATE_ASSETS. |
PUT | /api/styles/{id} | app key + user, entitlement | Update one authored canvas. Needs CREATE_ASSETS. |
GET | /api/styles/{id}/canvases | app key | Every authored canvas with its real width, height and aspect. |
GET | /api/styles/{id}/sticker-zone | app key | The sticker placement zone declared by a canvas. |
PUT | /api/styles/{id}/sticker-zone | app key + user, entitlement | Set that zone. Needs MANAGE_TEMPLATES. |
PATCH | /api/styles/pages/{id}/product-types/{productType} | app key + user, entitlement | Per-product-type royalty override. Needs CREATE_ASSETS. |
GET | /api/styles/artists/{id}/assets | app key, user optional | One artist's whole body of work - their series and every sticker they own. No domain filter, so a series holding only stickers appears here and in no catalog list. ?includeUnapproved= and ?includeInactive= need the artist themselves or MANAGE_TEMPLATES. |
Rendering
| Method | Path | Auth | Purpose |
|---|---|---|---|
GET | /api/styles/pages/preview/{id} | app key | Sample preview with placeholder content. ?format= and ?productType=. |
POST | /api/styles/pages/preview/{id} | app key | Live preview from content you supply. |
POST | /api/styles/pages/generate/{id} | app key + user, entitlement | Final-quality SVG of a smart product in this style set: { pageId, format? }. Needs CREATE_ASSETS or MANAGE_TEMPLATES. |
POST | /api/styles/pages/preview-draft | app key + user, entitlement | Preview an unsaved style set. Needs CREATE_ASSETS. |
GET | /api/styles/pages/validate/{id} | app key | Check a style set renders cleanly before publishing against it. |
Tickets
| Method | Path | Auth | Purpose |
|---|---|---|---|
GET | /api/styles/tickets | app key | List ticket styles. |
GET | /api/styles/tickets/{id} | app key | One ticket style. |
GET | /api/styles/tickets/preview/{id} | app key | Sample ticket preview. |
POST | /api/styles/tickets/preview/{id} | app key | Live ticket preview from supplied content. |
GET | /api/styles/ticket-sets | app key | List ticket style sets. |
POST | /api/styles/ticket-sets | app key + user, entitlement | Create a ticket style set. Needs CREATE_ASSETS or MANAGE_TEMPLATES. |
DELETE | /api/styles/ticket-sets/{id} | app key + user, entitlement | Delete it. Needs CREATE_ASSETS or MANAGE_TEMPLATES. |
GET | /api/styles/ticket-sets/{id} | app key | One ticket style set. |
PUT | /api/styles/ticket-sets/{id} | app key + user, entitlement | Update it. Needs CREATE_ASSETS or MANAGE_TEMPLATES. |
Review and earnings
| Method | Path | Auth | Purpose |
|---|---|---|---|
POST | /api/styles/pages/{id}/submit | app key + user, entitlement | Submit a style set for review. Needs CREATE_ASSETS or MANAGE_TEMPLATES. |
POST | /api/styles/pages/{id}/review | app key + user, entitlement | Approve or reject a submission. Needs MANAGE_TEMPLATES. |
GET | /api/style-sets/{id}/contributions | app key | Contribution rows crediting this style set's artist. |
GET | /api/style-sets/{id}/earnings | app key | What this style set has earned. |
Stickers
| Method | Path | Auth | Purpose |
|---|---|---|---|
GET | /api/stickers | app key | List stickers. |
POST | /api/stickers | app key + user, entitlement | Create a sticker. Needs CREATE_ASSETS. |
DELETE | /api/stickers/{id} | app key + user, entitlement | Delete a sticker. Needs MANAGE_STICKERS. |
GET | /api/stickers/{id} | app key | One sticker. |
PUT | /api/stickers/{id} | app key + user, entitlement | Update a sticker. Needs MANAGE_STICKERS. |
POST | /api/stickers/{id}/submit | app key + user, entitlement | Submit a sticker for review. Needs CREATE_ASSETS or MANAGE_STICKERS. |
POST | /api/stickers/{id}/review | app key + user, entitlement | Approve or reject a sticker. Needs MANAGE_STICKERS. |
GET | /api/stickers/{id}/contributions | app key | Contribution rows crediting this sticker's artist. |
GET | /api/stickers/{id}/earnings | app key | What this sticker has earned. |