Skip to content
View Markdown

API / SDK integrator

Use this path when you are embedding WEARFITS in a custom site, app, or middleware. Choose an outcome first. The developer index maps each outcome to a host and a reference page.

If the merchant is on Shopify or WooCommerce, prefer the native app or plugin. Build a custom embed when the recipe says the app does not cover that outcome — shoe size and bags are the usual cases.

1. API keys

Create a key at dash.wearfits.com. Send it as X-API-Key on api.wearfits.com requests. Product SDKs that run in the shopper browser use the key or embed URL documented for that product — do not put server secrets in storefront JavaScript.

The shoe-size widget does not use this key. It uses a public clientId that WEARFITS registers. Recommend a shoe size.

Usage for AR and AI try-on is reported by the product SDKs. Custom server-to-server usage reporting is not a public API.

2. Canonical APIs

Base URL: https://api.wearfits.com

Product Endpoint Docs
2D → 3D shoes POST /api/v1/shoe-3d then GET /api/v1/jobs/{jobId} API reference
Clothing digital twin POST /api/v1/digital-twin Clothing API
Clothing virtual fitting POST /api/v1/virtual-fitting Clothing API
Clothing size POST /api/v1/size-fitting Clothing size recipe
AR product / viewer https://dev.wearfits.com and /tryon AR API, AR SDK
Shoe size (store widget) Size SDK on size.wearfits.com Shoe size recipe, Size SDK

Always use POST /api/v1/shoe-3d — not a legacy /shoe3d path — in new integrations.

POST /api/v1/size-fitting is clothing only. Do not send it a shoe.

Interactive explorer: api.wearfits.com/reference.

3. Hosted embed guides

An on-shoe fit picture is not part of the shoe-size widget or the clothing size API. The widget returns the advisory modal only.

4. Platform apps

If the merchant is on Shopify or WooCommerce, prefer the native app or plugin instead of a from-scratch embed:

  • Shopify — shoe AR, and apparel only when that access is already on the store. No shoe size.
  • WooCommerce — shoe AR, plus an earlier-stage clothing iframe. No shoe size.