Empezar
TypeScript SDK
Un pequeño cliente tipado para los entornos de ejecución Node 18+, Deno, Bun y edge.
Los ejemplos de código, los puntos finales y los códigos de error son los mismos en todos los idiomas.
Un cliente pequeño y sin dependencias, con tipos completos de TypeScript. Funciona en Node 18+, Deno, Bun y entornos edge. Solo en el servidor.
Instalación
El paquete se está preparando para npm. Mientras tanto, descarga el archivo único en tu proyecto:
curl -o tryoncloud.mjs https://www.tryoncloud.com/sdk/tryoncloud.mjsfetch funciona igual de bien. El SDK solo te ahorra construir el formulario, interpretar los errores y leer las cabeceras. Consulta Generar una prueba.Uso
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étodo | Devuelve | Endpoint |
|---|---|---|
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? }) | la tarea (status: "queued") | POST /generations |
getGeneration(id) | la tarea | GET /generations/:id |
waitForGeneration(id, { intervalMs?, timeoutMs? }) | la tarea terminada (consulta periódica) | GET /generations/:id |
createBatch({ items, webhookUrl?, mock? }) | el lote | POST /batches |
getBatch(id) | el lote con cada elemento | GET /batches/:id |
cancelBatch(id) | el lote, con cancelled_now y refunded_credits | DELETE /batches/:id |
getResult(resultId) | los bytes de la imagen | GET /results/:id |
deleteResult(resultId) | nada | DELETE /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 |
Imágenes de entrada:
{ url }: una URL de imagen https pública (la prenda, o la persona encreateGeneration){ base64 }: una cadena base64{ data, filename? }: unBlob,ArrayBuffer,Uint8Arrayo unBufferde Node
Los errores se lanzan como TryOnCloudError, con status, code (consulta Errores), requestId, details (campos adicionales como used y limit) y retryAfter en un 429.
Tareas asíncronas y lotes
// 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",
})Consulta Tareas asíncronas, lotes y webhooks para los límites y los eventos.
Verificar los webhooks
Pasa el cuerpo sin procesar de la solicitud, las cabeceras y tu secreto de firma (API Keys > Webhooks):
// 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")
}Las entregas con más de 5 minutos se rechazan, así que una entrega interceptada no se puede reenviar.
Modo de prueba
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