View Markdown

Dashboard — User Guide

This guide covers everything needed to get started with the WEARFITS SaaS Dashboard: authentication, day-to-day navigation, API key management, billing, and troubleshooting.

Getting Started

WEARFITS uses a passwordless authentication system. No password is ever set or required.

Go to dash.wearfits.com and enter your business email address.
Check your inbox for a "Sign in to WEARFITS" email sent from msg.wearfits.com.
Click the login button in the email. The link is valid for a single session only.

Smart Onboarding (New Customers)

First-time customers with product access are guided through a Smart Onboarding flow after registration. During this flow you select your primary technology — AR (Augmented Reality) for footwear and bags, or AI (Generative AI) for clothing — and complete your initial integration setup.

New accounts without product access are sent to Pricing first. Onboarding becomes available after access is active.

Welcome Screen

After your first successful purchase, a Welcome Screen is displayed. It summarises:

Your active plan features.
Your immediate limits: try-ons, products, and API keys.
Direct links to the developer documentation for each SDK.

Account Access

New accounts without product access are redirected to the Pricing page after sign-in instead of the main dashboard. Direct visits to product tools are restricted as well.

Pricing remains available so you can choose a plan.
Activity remains available so you can review account activity.
Product tools and API keys become available once product access is active.

Existing accounts that already have product access keep it. When access becomes active, the same signed-in session can continue into the dashboard.

Overview (Home)

The Overview page is your central hub for real-time account monitoring.

Section	What it shows
Plan Status Card	Current tier (FREE / STARTER / PRO), billing cycle end date, and subscription health.
Usage Snapshot	Real-time progress bars showing consumption against your monthly try-on limits.
Quick Tools	One-click access to the Models Library and the dashboard Upload 3D tool.

Models Library

The Models Library is the dashboard workspace for uploading, classifying, sharing, downloading, filtering, and deleting your 3D models. Open it from the Tools menu or Quick Tools when it is available for your account.

Uploading a 3D Model

Open the Models Library or the dashboard Upload 3D tool.
Select a supported 3D model file and complete the upload.
Open the uploaded model in the library to review its details and set its try-on asset type.

Models uploaded from the dashboard are associated with your WEARFITS account and appear in your own library.

Classifying a Model

On the model screen, choose a Try-on asset type. The selection is saved immediately; there is no separate Save button. Available types include Shoe, Handbag, Handbag in hand, Backpack, Hat, Watch, Accessory, and Other.

The selected type determines the appropriate try-on editor when one is available. Choosing a type does not by itself configure try-on. If the 3D product contains a type this dashboard does not recognize, it is shown as-is until you choose a replacement.

Filters and Saved Views

Search, mesh type, try-on asset type, owner, sorting, and page selection are reflected in the page address. You can reload, bookmark, or share a filtered view and return to the same results. Opening a model and selecting Back to models preserves the filters and sorting you used.

The model screen can provide:

A Download file action for the uploaded model.
Public links for the available 3D preview, AR preview, and camera try-on screens.
QR codes for links intended to be opened on a phone.

Anyone with a public model link can open it without a Dashboard account. When a model has material presets, the selected preset is included in links that support presets.

If you have permission to remove a model, Delete is available from both its library card and its model screen. Confirm the action to move the model to trash. After deletion, the library returns to the current filtered view.

Usage Analytics

The Usage Analytics section provides a historical view of your platform activity.

Time ranges: Toggle between 7 days, 30 days, and 90 days to examine trends over different windows.

Tracked metrics:

Metric	Description
AR Try-ons	Each successful Augmented Reality try-on initialisation (footwear / bags).
AI Try-ons	Each generated outfit preview produced by the AI try-on engine.
API Calls	Total requests made using your API keys across all integrations.

Trend badges appear above each chart and indicate whether usage has increased or decreased compared to the equivalent previous period.

Note: Usage statistics are calculated in near real-time but may carry a 1–5 minute delay during peak traffic periods.

Recent Activity

The Activity Log records every significant event on your account:

API Key events — creation and deletion, including who performed the action and when.
Plan changes — upgrades, downgrades, and cancellations.
Security events — successful logins with the IP address and browser information recorded for each action.

API Key Management

API keys are the credentials that link your storefront or backend to WEARFITS technology. Each key must be authenticated with every SDK or API request.

Creating a Key

On the Home page, navigate to the API Keys section.
Click Create New API Key.
Enter a descriptive label, for example Shopify Production or Testing.
Copy the key immediately — for security reasons, the full key value is shown only once at creation time.

All keys currently use the footwear_ namespace prefix, which is optimised for shoes and accessories.

API key management requires product access. New accounts without product access are sent to Pricing; Activity remains available.

SDK Authentication

Every SDK call must include your API key in the headers or the SDK configuration object. Your Dashboard tracks activity per key across three quota buckets:

AR Try-ons — each successful AR initialisation.
AI Generations — each generated image or preview.
API Calls — total global requests for asset retrieval and synchronisation.

Key Rotation

Keys have an expiration date that depends on your plan tier. Best practice is to create a replacement key and update your integration at least two weeks before the old key expires to avoid service interruption.

SDK & Integration Options

WEARFITS offers multiple integration paths depending on your product category.

Category	Integration
Footwear & Bags (AR)	SDK & Integration Guide · 3D Model Library
Clothing (AI)	AI Try-On Integration · AI API Reference
Asset Digitisation (Photo → 3D)	Photo-to-3D Integration API

The SDKs handle usage reporting automatically: on each try-on or generation the SDK authenticates with the API key and increments the appropriate usage counter. Real-time statistics are then visible in your Dashboard. Custom server-to-server usage reporting is not a public API.

Subscriptions & Billing

Plan Tiers

WEARFITS offers separate subscription tiers for AR (Footwear) and AI (Clothing) products.

Tier	Intended use
FREE	Available to existing accounts that already have access; new accounts need a paid plan.
STARTER	Growing brands that need greater try-on volume.
PRO	High-volume enterprise stores.

Product limits are cumulative — they do not reset each month. Upgrading to a higher tier increases your total product allowance permanently.

Managing Your Subscription

Access the Stripe Customer Portal from within the Dashboard to:

Update your credit card or billing address.
View and download past invoices.
Cancel or upgrade your plan. New limits apply immediately upon upgrade.

FAQ & Troubleshooting

My API key is returning a "Forbidden" error. Check three things: confirm the key has Active status in your Dashboard, make sure your account has product access, and verify that your Product Limit has not been exceeded. If your account has no product access, open Pricing and activate a paid plan; if the product limit is the issue, upgrade your plan.

How do I increase my Product Limit? Go to the Pricing page and select a higher tier. Product limits are cumulative across the lifetime of your subscription and do not reset monthly.

I did not receive my Magic Link. Confirm you are using the email address registered on your account. Check your spam or junk folder and add a filter to allow emails from msg.wearfits.com.

My usage statistics look delayed. This is expected behaviour. Statistics are near real-time but may lag by 1–5 minutes during peak periods.

For technical support, integration assistance, or enterprise inquiries, contact support@wearfits.com.