@acuityai/acuityai

AcuityAi SDK

The acuityai SDK is library that uses https://acuityai.com for implement shoppable in video element by utilizing our easy interface.

Working samples

• Sample 01
• Sample 02

Get started

Installing

Import using the module

npm install --save @acuityai/acuityai

# or
yarn add @acuityai/acuityai

import '@acuityai/acuityai/dist/acuityai-sdk.css';
import acuityai from '@acuityai/acuityai';

Using gloably via CDN

<link rel="stylesheet" href="https://assets.acuityai.com/acuityai-sdk.css">
<script src="https://assets.acuityai.com/acuityai-sdk.js"></script>

Using

Example:

acuityai.init({
  company: 'stacio',
  checkoutButtonContainer: '#checkout-button',
  shoppingContainer: '#shopping-panel',
  productContainer: '#product-panel',
  vertical: '123',
  group: '123',
});

property	type		description
company	string	required	name of the company created on the https://customer.acuityai.com
checkoutButtonContainer	string	required	Container selector to render checkout button, you can develop your custom own using the events and actions
shoppingContainer	string	required	Contianer selector to render product popup
productContainer	string	required	Container selector to render product panel with products on the group
vertical	string	required	this is the vertical id that you can get from the https://customer.acuityai.com of the related to the vertical
group	string	required	this is the group id that you can get from the https://customer.acuityai.com of the related to the group vertical

Events

Example:

const onUpdateCart = (event) => console.log(event);

// Listen events listener
acuity.on('cart:update', onUpdateCart);

// Remove event listener
acuity.off('cart:update', onUpdateCart);

name	signature
cart:update	(total: number) => void

Actions

Example:

// Mark checkout as a conversion
acuity.conversion();

name	signature	description
clean	() => void	Clean cart product
conversion	() => void	Mark checkout as a conversion and also clean cart