What you need to know and to do to propose a 3D Viewer experience to your customers
Reminder
Even though the 3D Viewer is part of the VTO Product, it requires to be enabled in the license (via subscription to the 3D Viewer module).
Furthermore, to ensure a good user experience, the 3D Viewer only accepts assets with the required level of quality (see below).
Check the frame availability (for 3D Viewer)
Request the availability endpoint to check if the frame is available in 3D View (see Availability endpoint documentation) and enable the Call-To-Action (CTA) button only in this scenario.
The availability endpoint evolved to now inform if a frame is "available" in virtual try-on (VTO) and if the frame is "viewerCompatible".
Only display the CTA for the 3D Viewer experience if the frame is "viewerCompatible".
Start directly with the 3D Viewer
The 3D Viewer serves as an additional mode to the virtual try-on, similar to the "Live" and "Photo" try-ons. When the CTA is clicked, start the VTO in the 3D Viewer with a call to: startVto("viewer").
Switch between the 3D Viewer and the VTO
As always, the VTO automatically provides a UI for the end-user to switch between both mode (when available).
However, you can control the switch yourself or offer a different UI/UX. Switching between both modes is done by calling the setMode() method with the target mode (e.g. setMode("viewer") and setMode("live")).