Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Wizart Visualizer API allows developers to programmatically access the same powerful features used in the Wizart Visualizer app. By leveraging the API, you can integrate realistic room visualizations, apply products like flooring and wall coverings, and manage interiors—all within your own applications.

This guide will walk you through the essential steps to start using the Wizart Visualizer API effectively.

1. Subscribing to the Visualizer API

The Visualizer API is available for purchase on AWS Marketplace, where you can subscribe to different pricing plans based on your usage needs. To subscribe, you'll need an AWS account. If you don’t have one, you’ll need to sign up.

How to Subscribe via AWS Marketplace

  1. Create or Sign In to Your AWS Account: If you don’t have an AWS account, sign up for an account here. If you already have one, sign in to your account.

  2. Visit the Visualizer API Product Page: Once signed in, go to the Visualizer API page on AWS Marketplace (insert the exact URL here).

  3. Choose a Plan: Review the available pricing plans:

    • Basic Plan: Pay-as-you-go, no request limit, but a higher cost per request.

    • Other Plans: Includes a fixed number of requests, with additional requests charged at a lower rate than the Basic Plan.

    The user can choose both the plan and the subscription duration. After selecting a plan, you will need to press the Pay button, which will direct you to a registration form.

  4. Fill in the Registration Form: It is important to properly fill in your personal name, email, and company name in the registration form. This data will be used to create your personal account in the Wizart Administrative Panel (WAP).

  5. Submit and Wait for Confirmation: After submitting the form and receiving a confirmation message, wait a few minutes for an email with access details and further instructions. This email will be sent to the address you provided during registration.

  6. Complete Purchase: Follow the on-screen instructions to finalize your purchase through AWS.

Pricing and Request Limits

Each tariff plan includes a fixed number of requests per contract. If your usage exceeds this quota, additional requests will incur a fee. Payable requests include:

  • Uploaded Images: Each image uploaded through the API counts as one request.

  • Renders: Each render generated via the API counts as one request.

The Basic Plan has no limits, and you pay for each request you make, but the cost per request is higher compared to subscription plans. If you anticipate higher usage, subscription plans may offer better cost-efficiency.

...

2. API Reference and Postman Integration

We provide an extensive API reference that outlines all available endpoints. Whether you're fetching products, managing rooms, or applying materials, this reference is your go-to guide for interacting with the API.

...

Now you’re ready to start experimenting with the endpoints!

...

3. API Authentication Setup

Every request to the Wizart Visualizer API must be authenticated using your API Token.

...

Device-Token: your-device-token

...

4. Accessing the Wizart Admin Panel

Once your API token is set up, you will also have access to the Wizart Admin Panel, a platform that helps you explore and manage products and interiors. The Admin Panel gives you a head start by providing an initial set of products and interiors shared with your account.

...

In addition to reviewing the preloaded data, you’ll eventually be able to upload and manage your own products through the catalog management system, which is integrated into the Admin Panel. Once you’re familiar with how the system works, you can begin making API requests to visualize your own products and spaces.

...

5. Applying Products to a Room via API

The Wizart Visualizer API allows you to apply products such as wallpapers, floorings, and other materials to specific rooms. To accomplish this, follow the steps outlined below to retrieve the necessary room data, add product information, and submit the final request.

...