Concepts

✨ Features

You can do more with Sprie:

  1. Allow customers to virtually try-on your products
  2. Show them quick variations in the try-on widget itself.
  3. Allow customers to directly add the product to your platform cart
  4. Allow them to add a product to wishlist.
  5. Let them share their picture with their friends and family, how they look with your product on them.
  6. Gather critical insights and helpful analytics without compromising user privacy.

⛽️ Life Cycle

Sprie is meant to work on frontend javascript based apps only. You do not need to call any specific external URLs to communicate with Sprie Servers as SprieSDK does it on your behalf ( for authentication, checking registry, downloading 3d files) through an encrypted layer.

Sprie enabled Apps have very specific lifecycle :

  1. Integrate SDK
  2. Initializes with api-key
  3. (optional) Check if certain SKU or SKUs are registered with Sprie
  4. (optional) on proper check result, set visibility of Trigger/Preview button
  5. Trigger the Virtual Try On
  6. (optional) Handle Events for specific use-cases (check of webcam permission, authentication result, etc)
  7. Customize Sprie

🥁 Terminology

TermDefinition
SprieSDKGlobal window object SprieSDK, used for communicating with Sprie Servers
api-keyThe encrypted api-key received from Sprie upon organization onboarding. Used for initializing SprieSDK. Can be revoked upon request. Expires automatically when contract ends.
SKUStock Keeping Unit. Uniquely identify a single product in the onboarded e-commerce platform. Used for sending/loading the product on AR. Can be any unique-id (url param, db id, etc). Can be updated on Sprie Servers accordingly.
TriggerAny Preview button that triggers the virtual try-on with a specific product SKU.
Registered ProductAccording to your plan, you can choose to either onboard all the products in your e-commerce, or just few. As a proper user experience, you should always check if a product is registered with Sprie or not before showing the Trigger/ Preview button.
Virtual Try-onThe Sprie Widget that opens up on the website upon triggering the SDK.