/
Visualizer API Overview

Visualizer API Overview

Owned by Andrei Dyakov
2024-09-24
2 min read

The Visualizer API is a REST API that serves as the core of the Wizart Visualizer app, enabling the application to communicate with the backend. Everything that can be achieved through the Wizart Visualizer app can also be done programmatically using the API. It provides flexibility and full control over how products, rooms, and collections are visualized in various environments.

This API is especially useful for developers looking to integrate the powerful visualization capabilities of Wizart into their own applications, allowing you to leverage product data and visualization features without needing the full visualizer UI. The API supports all the essential features needed to visualize products in realistic interiors and manipulate them interactively.

Key Features

  1. Room Visualizations: The API allows you to apply materials, textures, and patterns to different rooms, enabling realistic previews for customers. This can be used to show how products (such as flooring, wall coverings, and ceiling materials) will look in a variety of spaces.

  2. Product Management: You can fetch details about brands, collections, and specific products (articles) from the API, making it easy to integrate with your existing catalog data.

  3. Applying Textures: The apply endpoint allows you to apply a texture to a specific room, returning a base64-encoded string of the updated room image. This enables real-time material previews for customers.

  4. Room and Interior Management: The API provides access to predefined and custom rooms, allowing you to pull room data for visualizations.

  5. Filtering and Searching: Search functionality allows you to find articles within a specific brand or collection, or search for products across the catalog.

Access to the Wizart Platform

When you purchase a subscription to the Visualizer API (for instance, through AWS Marketplace), you also gain access to the Wizart Platform, which provides a robust product catalog management system. This allows you to:

  • Manage your product catalog directly through the Wizart platform, enabling you to organize brands, collections, and products with ease.

  • Upload, edit, and manage product data that can be accessed through the API or the Wizart Visualizer.

  • Ensure seamless synchronization of your catalog across your visualization needs, whether through the API or within the Wizart ecosystem.

For a detailed overview of the Wizart PIM system, including how to get started with product catalog management, read the full article here.

Versioning

The Visualizer API is currently available in multiple versions, with v1.0 and v1.1 being the most common. Each version provides various endpoints for managing rooms, products, brands, and collections. It's essential to use the correct version of the API based on your application's needs.

Authentication:

  • API Token: Access to the API is secured via an API token, which is provided to users upon subscription (for instance, through AWS Marketplace). This token must be included in every request’s X-Api-Key header.

  • Device-Token: is generated by your application for each unique session. These tokens ensure that API interactions are secure and scoped to individual sessions or users.