Search docs

Search the TryOnCloud API docs

Los geht’s

TypeScript SDK

Ein kleiner, typisierter Client für Node 18+, Deno, Bun und Edge-Laufzeitumgebungen.

Code-Beispiele, Endpunkte und Fehlercodes sind in jeder Sprache identisch.

Ein kleiner Client ohne Abhängigkeiten, mit vollständigen TypeScript-Typen. Läuft auf Node 18+, Deno, Bun und Edge-Runtimes. Nur serverseitig.

Installation

Das Paket wird für npm vorbereitet. Bis dahin laden Sie die einzelne Datei in Ihr Projekt herunter:

bash
curl -o tryoncloud.mjs https://www.tryoncloud.com/sdk/tryoncloud.mjs
Tipp: Ein einfaches fetch funktioniert genauso gut. Das SDK erspart Ihnen nur das Zusammenbauen des Formulars, das Auswerten von Fehlern und das Lesen der Header. Siehe Anprobe erzeugen.

Verwendung

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

MethodeRückgabeEndpunkt
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? })der Auftrag (status: "queued")POST /generations
getGeneration(id)der AuftragGET /generations/:id
waitForGeneration(id, { intervalMs?, timeoutMs? })der fertige Auftrag (fragt regelmäßig ab)GET /generations/:id
createBatch({ items, webhookUrl?, mock? })der BatchPOST /batches
getBatch(id)der Batch mit allen EinträgenGET /batches/:id
cancelBatch(id)der Batch, mit cancelled_now und refunded_creditsDELETE /batches/:id
getResult(resultId)die Bild-BytesGET /results/:id
deleteResult(resultId)nichtsDELETE /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 oder false

Bildeingaben:

  • { url }: eine öffentliche https-Bild-URL (das Kleidungsstück, oder die Person bei createGeneration)
  • { base64 }: ein Base64-String
  • { data, filename? }: ein Blob, ArrayBuffer, Uint8Array oder Node-Buffer

Fehler werden als TryOnCloudError geworfen, mit status, code (siehe Fehler), requestId, details (zusätzliche Felder wie used und limit) und retryAfter bei 429.

Asynchrone Aufträge und Batches

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",
})

Limits und Ereignisse finden Sie unter Asynchrone Aufträge, Batches und Webhooks.

Webhooks prüfen

Übergeben Sie den unveränderten Request-Body, die Header und Ihr Signatur-Secret (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")
}

Zustellungen, die älter als 5 Minuten sind, werden abgelehnt, sodass eine abgefangene Zustellung nicht erneut abgespielt werden kann.

Testmodus

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