Ocavu Reference Guide

Installation - How can I use QR codes?

Requirements:

QR codes are an effective way to guide users from desktop platforms and printed materials to a 3D/AR experience. However, an important secondary objective is to ensure that the user is directed to (or remains on) a webpage controlled by your brand, such as a product detail page.

Ocavu provides the following implementation strategies that ensure the success of both objectives.

QR codes to web pages that have the Ocavu Web SDK Installed

Additional Requirement:

This is the recommended strategy. It directs your users to your website and keeps them there after the 3D/AR experience.

Steps:

  1. User scans the QR code.
  2. User lands on your web page and after the Ocavu Web SDK loads it automatically launches the 3D/AR experience
  3. After the experience exits, the user is still on your web page.

How to construct a QR code that auto-launches Ocavu Experiences on your web page:

  1. Copy the URL of the target webpage that has the Ocavu Web SDK installed (typically, a product detail page).
  2. Take note of the configured model key of the desired model in Ocavu Portal (often, it matches the SKU of your product).
  3. Add to the target webpage URL the Ocavu auto-launch query parameter: ?ocavu-key=YOUR_MODEL_KEY (replace YOUR_MODEL_KEY)
  4. Generate a QR code from the modified URL using the following tool:




QR Code Will Generate Here

How to embed a QR code using the Ocavu SDK:

  1. Add a new <img> element to the target webpage.
  2. Take note of the configured model key for your desired model.
  3. Add the data-ocavu-key and data-ocavu-qr attributes to the <img> element as shown and replace YOUR_MODEL_KEY with the desired key: <img data-ocavu-key="YOUR_MODEL_KEY" data-ocavu-qr>

Example:

Scan this QR to view a model in your space!

QR codes to Ocavu Portal standalone model pages

Additional Requirement:

  • A "Link URL" added to the details of each 3D model in Ocavu Portal

This strategy is typically used for prototyping or when you do not have sufficient permissions to modify your website.

Steps:

  1. User scans the QR code.
  2. User lands on an Ocavu controlled webpage and the 3D/AR experience will automatically launch (the webpage can be customized to match your brand).
  3. After the experience exits, the user can click a button to visit the configured "Link URL" (which should be the product detail page on your website).

How to get a QR code to a Standalone Model Page:

  1. Navigate to Ocavu Portal.
  2. Select the desired model.
  3. Click the "Share" action from the context menu, dropdown, or toolbar.
  4. A dialog will appear that contains a link to that model's standalone page, as well as a QR code of that link.