Search docs

Search the TryOnCloud API docs

Inizia

TypeScript SDK

Un piccolo client tipizzato per Node 18+, Deno, Bun e i runtime edge.

Gli esempi di codice, gli endpoint e i codici di errore sono gli stessi in ogni linguaggio.

Un client piccolo e senza dipendenze, con tipi TypeScript completi. Funziona su Node 18+, Deno, Bun e runtime edge. Solo lato server.

Installazione

Il pacchetto è in preparazione per npm. Nel frattempo, scarica il singolo file nel tuo progetto:

bash
curl -o tryoncloud.mjs https://www.tryoncloud.com/sdk/tryoncloud.mjs
Suggerimento: anche un semplice fetch va benissimo. L'SDK ti evita solo di costruire il modulo, interpretare gli errori e leggere le intestazioni. Vedi Genera una prova.

Utilizzo

js
import { readFile, writeFile } from "node:fs/promises"
import { TryOnCloud, TryOnCloudError } from "./tryoncloud.mjs"

const client = new TryOnCloud() // reads TRYONCLOUD_API_KEY

try {
  const result = await client.generate({
    garment: { url: "https://cdn.yourstore.com/shirt.jpg" },
    person: { data: await readFile("person.jpg"), filename: "person.jpg" },
    customerId: "shopper_123",          // optional, your own end-user id
    idempotencyKey: crypto.randomUUID(), // optional, a retry is never charged twice
  })
  await writeFile("result.png", result.image)
  console.log("free credit?", result.creditWasFree, "request", result.requestId)
} catch (e) {
  if (e instanceof TryOnCloudError && e.code === "NO_CREDITS") {
    console.log("Out of credits, top up in the dashboard")
  } else if (e instanceof TryOnCloudError && e.code === "KEY_LIMIT_REACHED") {
    console.log("This key used its monthly limit", e.details) // { used, limit }
  } else throw e
}

API

MetodoRestituisceEndpoint
new TryOnCloud({ apiKey?, baseUrl?, timeoutMs? })client
generate({ garment, person, mock?, customerId?, idempotencyKey? }){ image, contentType, resultId, creditWasFree, mock, requestId }POST /generate
createGeneration({ garment, person, mock?, customerId?, metadata?, webhookUrl?, idempotencyKey? })l'operazione (status: "queued")POST /generations
getGeneration(id)l'operazioneGET /generations/:id
waitForGeneration(id, { intervalMs?, timeoutMs? })l'operazione conclusa (interroga periodicamente)GET /generations/:id
createBatch({ items, webhookUrl?, mock? })il batchPOST /batches
getBatch(id)il batch con ogni elementoGET /batches/:id
cancelBatch(id)il batch, con cancelled_now e refunded_creditsDELETE /batches/:id
getResult(resultId)i byte dell'immagineGET /results/:id
deleteResult(resultId)nienteDELETE /results/:id
deleteCustomer(customerId){ results_deleted, records_cleared, webhook_events_deleted }DELETE /customers/:id
credits(){ credits_remaining, purchased_remaining, purchased_total, free_remaining, spends_from }GET /credits
TryOnCloud.verifyWebhook(rawBody, headers, secret)true o false

Immagini in ingresso:

  • { url }: un URL pubblico https di un'immagine (il capo, o la persona in createGeneration)
  • { base64 }: una stringa base64
  • { data, filename? }: un Blob, ArrayBuffer, Uint8Array o un Buffer di Node

Gli errori vengono generati come TryOnCloudError, con status, code (vedi Errori), requestId, details (campi aggiuntivi come used e limit) e retryAfter su un 429.

Operazioni asincrone e batch

js
// One async try-on, result fetched when ready
const job = await client.createGeneration({ garment, person, customerId: "shopper_123" })
const done = await client.waitForGeneration(job.id) // or receive a webhook instead
if (done.status === "completed") await writeFile("look.png", await client.getResult(done.result_id))

// A catalogue batch, notified by webhook
const batch = await client.createBatch({
  items: skus.map((s) => ({ garment_url: s.imageUrl, person_url: modelUrl, customer_id: s.sku })),
  webhookUrl: "https://example.com/hooks/tryoncloud",
})

Vedi Operazioni asincrone, batch e webhook per limiti ed eventi.

Verificare i webhook

Passa il corpo grezzo della richiesta, le intestazioni e il tuo segreto di firma (API Keys > Webhooks):

js
// Next.js route handler
export async function POST(request) {
  const raw = await request.text()
  if (!(await TryOnCloud.verifyWebhook(raw, request.headers, process.env.TRYONCLOUD_WEBHOOK_SECRET))) {
    return new Response("bad signature", { status: 401 })
  }
  const { event, data } = JSON.parse(raw)
  // event: generation.completed | generation.failed | batch.completed | webhook.test
  return new Response("ok")
}

Le consegne più vecchie di 5 minuti vengono rifiutate, quindi una consegna intercettata non può essere riprodotta.

Modalità di prova

js
const preview = await client.generate({ garment, person, mock: true }) // free, returns the person image
const testJob = await client.createGeneration({ garment, person, mock: true }) // free, completes without a render