Getting Started
Introduction
What you need before you write any code.
What you'll need
- API keys for your instance — see Authentication. Keys are issued by the Viewa team during onboarding.
- A product catalog configured for your instance. Your Viewa contact sets this up with you; the API then exposes it through the catalog endpoints.
The pipeline at a glance
Every visualisation follows the same shape, whether you use the widget or the raw API:
- Upload — the customer's photo of their space (JPEG, PNG, or WebP).
- Areas — the customer marks the corners of each area to cover (a window, a door opening). This produces the measurements the renderer needs.
- Selection — your product page tells us which product and material the customer has chosen, by your own SKU or by Viewa catalog ID.
- Render — request a composite; poll until it's ready; display it.
Environments
All requests go to your instance's API under /api/v1. There is no separate sandbox
host — test keys against your own instance during integration.
The API is currently in pilot. Surfaces marked as in progress in these docs are being finalised and may change before general availability.