Skip to content

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.

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

Smart Onboarding (New Customers)

First-time customers 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.

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.

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 3D Model Library and the product Upload tool.

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

  1. On the Home page, navigate to the API Keys section.
  2. Click Create New API Key.
  3. Enter a descriptive label, for example Shopify Production or Testing.
  4. 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.

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) Website 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. If you are building a custom server-to-server integration that must report usage directly, refer to the Integration API Reference.


Subscriptions & Billing

Plan Tiers

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

Tier Intended use
FREE Testing and small-scale integration.
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.

Admin Panel (Staff Only)

WEARFITS staff with administrative access can reach the admin panel at the /admin route. It provides:

  • User Insights — full activity trails and usage history for any client account.
  • Impersonation — temporarily view the Dashboard as a specific user to assist with technical support.
  • Feature Toggles — enable or disable experimental features (such as advanced AI analytics) on a per-account or global basis.

FAQ & Troubleshooting

My API key is returning a "Forbidden" error. Check two things: confirm the key has Active status in your Dashboard, and verify that your Product Limit has not been exceeded. 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.