Reliefs Docs
Management APIProducts

Generate an App Clip scan link

Generates a one-shot capture package for the iOS App Clip scan flow. Returns a presigned upload URL, encrypted payload, and ready-to-use App Clip invocation URL. Valid for 1 hour. Requires a management API key (`mk_`).

POST
/api/v1/management/restaurants/{restaurantId}/products/{productId}/generate-scan-link

Authorization

ManagementApiKey
X-Api-Key<token>

Management API key — starts with mk_. Generate one from your dashboard.

In: header

Path Parameters

restaurantId*string

Restaurant ID

Formatuuid
productId*string

Product ID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/management/restaurants/497f6eca-6276-4993-bfeb-53cbbbba6f08/products/497f6eca-6276-4993-bfeb-53cbbbba6f08/generate-scan-link"
{  "success": true,  "data": {    "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",    "presignedUrl": "http://example.com",    "encryptedPayload": "string",    "appClipUrl": "http://example.com"  }}

Publish a product draft

Publishes the draft of a product, making it publicly visible. Uses the product ID to find the associated draft. If the product was already published, the published version is updated. If it was a new (unpublished) product, a new published product is created. The draft is deleted upon successful publication. Requires a management API key (`mk_`).

Generate a 3D viewer iframe URL

Generates a short-lived URL (1h) for embedding the product's 3D model viewer in an `<iframe>`. The URL serves an HTML page with the viewer pre-configured — the raw GLB file URL is never exposed to the management client. This is an alternative to the SDK for backends with no JS runtime of their own (e.g. a CMS or server-rendered page) — frontends that can run JS should use the SDK instead. Requires a management API key (`mk_`).