post
https://api.sandbox.oysterskin.com/api/v1/skin/scan-session
Create a new scan session for QR code-based skin analysis flow.
The returned batch_id should be encoded into a QR code for customers to scan.
When the response includes a broadcasting block, clients may subscribe to
real-time status updates instead of polling — but should always keep the
GET /skin/scan-session/{batch_id} poll as a fallback, since the block is
absent whenever realtime is unavailable and the socket can drop mid-session.
WebSocket events:
- Channel:
scan-session.{batch_id}(public — the batch ID is the token) - Events: bind every name in
broadcasting.events. The event renames
itself per status:images_uploadedcarries the images-uploaded
transition,status.changedcarries analyzing, completed, failed and
expired. Binding one name silently misses the others. - Payload:
{ batch_id, status, reason, expires_at, completed_at }, plus
imagesonimages_uploaded. Readstatus— there is novalidfield
on the wire (it exists only on the REST status response).
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…