Search docs

Search the TryOnCloud API docs

Começar

TypeScript SDK

Um pequeno cliente tipado para os ambientes de execução Node 18+, Deno, Bun e edge.

Os exemplos de código, os pontos de extremidade e os códigos de erro são os mesmos em todas as línguas.

Um cliente pequeno e sem dependências, com tipos TypeScript completos. Funciona com Node 18+, Deno, Bun e runtimes edge. Apenas no servidor.

Instalação

O pacote está a ser preparado para o npm. Até lá, descarregue o ficheiro único para o seu projeto:

bash
curl -o tryoncloud.mjs https://www.tryoncloud.com/sdk/tryoncloud.mjs
Dica: um simples fetch funciona igualmente bem. O SDK apenas lhe poupa a construção do formulário, a análise dos erros e a leitura dos cabeçalhos. Consulte Gerar uma prova.

Utilização

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

MétodoDevolveEndpoint
new TryOnCloud({ apiKey?, baseUrl?, timeoutMs? })cliente
generate({ garment, person, mock?, customerId?, idempotencyKey? }){ image, contentType, resultId, creditWasFree, mock, requestId }POST /generate
createGeneration({ garment, person, mock?, customerId?, metadata?, webhookUrl?, idempotencyKey? })a tarefa (status: "queued")POST /generations
getGeneration(id)a tarefaGET /generations/:id
waitForGeneration(id, { intervalMs?, timeoutMs? })a tarefa concluída (consulta periódica)GET /generations/:id
createBatch({ items, webhookUrl?, mock? })o lotePOST /batches
getBatch(id)o lote com cada itemGET /batches/:id
cancelBatch(id)o lote, com cancelled_now e refunded_creditsDELETE /batches/:id
getResult(resultId)os bytes da imagemGET /results/:id
deleteResult(resultId)nadaDELETE /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 ou false

Imagens de entrada:

  • { url }: um URL público https de imagem (a peça de roupa, ou a pessoa em createGeneration)
  • { base64 }: uma cadeia base64
  • { data, filename? }: um Blob, ArrayBuffer, Uint8Array ou Buffer do Node

Os erros são lançados como TryOnCloudError, com status, code (consulte Erros), requestId, details (campos extra como used e limit) e retryAfter num 429.

Tarefas assíncronas e lotes

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

Consulte Tarefas assíncronas, lotes e webhooks para os limites e os eventos.

Verificar os webhooks

Passe o corpo do pedido sem alterações, os cabeçalhos e o seu segredo de assinatura (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")
}

As entregas com mais de 5 minutos são rejeitadas, pelo que uma entrega intercetada não pode ser reenviada.

Modo de teste

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