REST API

API pentru probă virtuală

Integrează proba virtuală Irisphera într-un magazin sau o aplicație personalizată prin API-ul REST: autentificare, sesiuni de cumpărător și generarea probei virtuale.

Solicită o cheie API

Pe această pagină

Înainte să începi
Prezentare generală
Autentificare
Endpointuri pe scurt
1. Adaugă produsele
2. Creează o sesiune de cumpărător
3. Generează o probă virtuală
Erori
Utilizare

Înainte să începi#

O cheie API de comerciant, emisă de Irisphera
Un server pe care îl controlezi, ca să păstrezi cheia secretă și să creezi sesiuni de cumpărător
Produse într-o colecție Irisphera, identificate prin SKU-ul tău

Prezentare generală#

API-ul este disponibil la https://api.irisphera.com și returnează erorile în format application/problem+json. Fiecare generare de probă virtuală costă 0,06 €. Vezi calculatorul de pe pagina de prețuri.

Documentația de referință completă a API-ului îți este trimisă împreună cu cheia API. Această pagină prezintă fluxul principal.

Autentificare#

Apelant	Header	Folosit pentru
Serverul tău	`MERCHANT-API-KEY: <key>`	Catalog, sesiuni de cumpărător și utilizare. Nu o pune niciodată în codul pentru browser sau pentru aplicații mobile.
Browserul sau aplicația cumpărătorului	`Authorization: Bearer <token>`	Apeluri de probă virtuală, cu un token cu durată scurtă de valabilitate creat de serverul tău.

Endpointuri pe scurt#

Method	Cale	Scop
POST	`/merchant/v2/collection-context`	Obține canalul pentru sesiunile de cumpărător
POST	`/merchant/v2/shopper-sessions`	Deschide o sesiune de cumpărător
POST	`/merchant/v2/shopper-sessions/{sessionId}/access-tokens`	Reîmprospătează tokenul unui cumpărător
GET	`/shopper/v2/stylist-preview/{skuCustomId}`	Verifică dacă un produs acceptă proba virtuală
POST	`/shopper/v2/stylist-preview`	Generează o probă virtuală
GET	`/merchant/v1/subscription`	Verifică cota și utilizarea

1. Adaugă produsele#

Creează o colecție și adaugă produse în ea, identificate prin SKU-ul tău (skuCustomId). Poți și importa o colecție dintr-un URL de feed.

2. Creează o sesiune de cumpărător#

Pe serverul tău, obține o singură dată canalul cu POST /merchant/v2/collection-context, apoi deschide o sesiune pentru fiecare cumpărător. Răspunsul include un accessToken și momentul expirării, expiresAt. Reîmprospătează-l cu POST /merchant/v2/shopper-sessions/{sessionId}/access-tokens.

Creează o sesiune

curl https://api.irisphera.com/merchant/v2/shopper-sessions \
  -H "MERCHANT-API-KEY: $IRISPHERA_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channelId": "<channelId>",
    "currentIdentity": {
      "namespace": "<namespace>",
      "kind": "ANONYMOUS",
      "externalId": "visitor-123"
    }
  }'

3. Generează o probă virtuală#

Verifică dacă un produs este pregătit cu GET /shopper/v2/stylist-preview/{skuCustomId}. Dacă categoria este UNAVAILABLE, nu oferi probă virtuală pentru el.

Apoi trimite fotografia cumpărătorului împreună cu SKU-ul produsului. Răspunsul conține generatedImage ca imagine WebP în base64, plus un resultUrl valabil 24 de ore.

Generează o probă virtuală

curl https://api.irisphera.com/shopper/v2/stylist-preview \
  -H "Authorization: Bearer $SHOPPER_TOKEN" \
  -F skuCustomId=DRESS-LILAC-S \
  -F [email protected] \
  -F isFaceBlurred=false

Notă

Formate de fotografie acceptate: PNG, JPEG, WebP și AVIF.

Erori#

Erorile folosesc formatul application/problem+json, cu un status, un titlu și detalii pe care le poți înregistra în loguri.

Important

Un răspuns 420 înseamnă că fotografia cumpărătorului nu a putut fi folosită. Cere-i alta în loc să reîncerci cu aceeași imagine.

Utilizare#

Verifică-ți cota și utilizarea curentă cu GET /merchant/v1/subscription.

Ți-a fost utilă această pagină?