Introduction

Welcome to the Web SDK documentation! Our Web SDK is designed to help you integrate powerful augmented reality features into your web applications quickly and efficiently. This guide will walk you through everything you need to know to get started and make the most of our SDK.

What is the Web SDK?

The Web SDK is a collection of tools and libraries that allow you to seamlessly integrate our services into your web applications. With the Web SDK, you can access a wide range of functionalities, such as brand authentication, data fetching, AR Engine and more, all with minimal setup and configuration.

Key Features

• Easy Integration: Simple installation and setup process to get you started quickly.
• Comprehensive API: Access a wide range of features and functionalities through our well-documented API.
• Cross-browser Compatibility: Compatible with all modern browsers to ensure a consistent experience for all users.
• Extensive Documentation: Detailed guides, examples, and API references to help you at every step of the integration process.

Who Should Use the Web SDK?

The Web SDK is ideal for developers who want to integrate our AR services into their web applications. Whether you are building a simple website or a complex web application, the Web SDK provides the tools and functionalities you need to enhance your application with our augmented reality features.

Prerequisites

Before you begin integrating the Web SDK, make sure you have the following:

• A basic understanding of JavaScript: Familiarity with JavaScript is essential for using the Web SDK.
• Node.js and npm/yarn installed: The Web SDK is distributed via npm, so you'll need Node.js and npm or yarn installed on your machine.
• Unique Brand API key: You will need a unique brand API key to authenticate and access our services. You can obtain an API key by contacting your mirrAR POC.

Getting Started

To get started with the Web SDK, follow these steps:

1. Enable Access: Contact your mirrAR POC to get access to the mirrar modules via github packages.
2. Install the SDK: Use npm or yarn to install the Web SDK in your project.
3. Start Using the SDK: Explore the various features and functionalities provided by the SDK and integrate them into your application.

Get Started with the Web SDK →

Resources

Here are some useful resources to help you get the most out of the Web SDK:

• API Reference: Detailed documentation of all the API methods and properties available in the Web SDK.
• Examples: Code examples to help you understand how to use the Web SDK in various scenarios.

We hope you find this documentation helpful and look forward to seeing what you build with our Web SDK!