REST API

API del probador virtual

Integra el probador virtual de Irisphera en una tienda o app a medida con la API REST: autenticación, sesiones de comprador y generación de pruebas.

Solicitar una clave de API

En esta página

Antes de empezar
Descripción general
Autenticación
Endpoints de un vistazo
1. Añade tus productos
2. Crea una sesión de comprador
3. Genera una prueba
Errores
Uso

Antes de empezar#

Una clave de API de comerciante, emitida por Irisphera
Un servidor bajo tu control, para mantener la clave en secreto y crear sesiones de comprador
Productos en una colección de Irisphera, identificados por tu SKU

Descripción general#

La API se sirve desde https://api.irisphera.com y devuelve los errores como application/problem+json. Cada generación del probador cuesta 0,06 €. Consulta el calculador de la página de precios.

La referencia completa de la API se comparte junto con tu clave de API. Esta página cubre el flujo principal.

Autenticación#

Quién llama	Cabecera	Uso
Tu servidor	`MERCHANT-API-KEY: <key>`	Catálogo, sesiones de comprador y uso. Nunca la incluyas en código de navegador ni de apps móviles.
Navegador o app del comprador	`Authorization: Bearer <token>`	Llamadas al probador, con un token de corta duración que crea tu servidor.

Endpoints de un vistazo#

Method	Ruta	Finalidad
POST	`/merchant/v2/collection-context`	Obtener tu canal para las sesiones de comprador
POST	`/merchant/v2/shopper-sessions`	Abrir una sesión de comprador
POST	`/merchant/v2/shopper-sessions/{sessionId}/access-tokens`	Renovar un token de comprador
GET	`/shopper/v2/stylist-preview/{skuCustomId}`	Comprobar si un producto admite el probador
POST	`/shopper/v2/stylist-preview`	Generar una prueba
GET	`/merchant/v1/subscription`	Consultar cuota y uso

1. Añade tus productos#

Crea una colección y añade productos a ella, identificados por tu SKU (skuCustomId). También puedes importar una colección desde la URL de un feed.

2. Crea una sesión de comprador#

En tu servidor, obtén tu canal una vez con POST /merchant/v2/collection-context y después abre una sesión para cada comprador. La respuesta incluye un accessToken y su hora de caducidad expiresAt. Renuévalo con POST /merchant/v2/shopper-sessions/{sessionId}/access-tokens.

Crear una sesión

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. Genera una prueba#

Comprueba que un producto está listo con GET /shopper/v2/stylist-preview/{skuCustomId}. Si la categoría es UNAVAILABLE, no ofrezcas el probador para ese producto.

Después, envía la foto del comprador junto con el SKU del producto. La respuesta contiene generatedImage como WebP en base64, además de una resultUrl válida durante 24 horas.

Generar una prueba

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

Nota

Formatos de foto admitidos: PNG, JPEG, WebP y AVIF.

Errores#

Los errores usan el formato application/problem+json, con un estado, un título y detalles que puedes registrar.

Importante

Una respuesta 420 significa que no se ha podido usar la foto del comprador. Pídele otra en lugar de reintentar con la misma imagen.

Uso#

Consulta tu cuota y tu uso actual con GET /merchant/v1/subscription.

¿Te ha resultado útil esta página?