Migration from e-Commerce SDK v5 API ​

This page is designed to help clients migrate from the deprecated older version of LIQA to the current one. This page contains information for clients, utilising LIQA e-Commerce v5 API, described in previous documentation.

Versions Comparison Summary ​

Migration Steps ​

1. Start by following the Quick Start integration with default settings
2. Add a function to perform image conversion from blob to base64 to match the /upload SaaS API.
3. If your application allows users to upload images from the device gallery, allow this option in the new LIQA by default and remove this feature from your application code.
4. Customize the LIQA interface style and texts. See UI styling and text replacement documentation pages.
5. Add error handling logic.
6. Test your application on mobile devices. Check system requirements for the best performance.
7. Check our recent updates regularly on the What's new? page.

Features Compatibility Notes ​

Lock version ​

The previous version (v5) offered a way to freeze LIQA version using a specific version from the NPM registry. The current version (v6) does not support this feature, as it receives automatic updates and bug fixes from the CDN.

Cache LIQA content ​

The previous version (v3) offered a way to cache LIQA iframe content by setting the Cache-Control header. The current version (v6) does not support this feature and we recommend to remove it from your code.

Pre-load files ​

The previous version (v5) offered a way to pre-load LIQA files by using the .load(...) API method. The current version (v6) offers a slightly different API method for it, check the Pre-loading LIQA files documentation page.

Change container size ​

The previous version (v5) offered a way to set LIQA container size by passing width and height parameters to the init method. The current version (v6) provides LIQA as a native web component, so you can set the size of the container natively.

Manually start LIQA session ​

The previous version (v5) offered a way to start LIQA session by calling the .play() method. The current version (v6) starts LIQA session automatically after the web component is rendered. You can postpone the session start by changing the visibility of the web component, check the guide about hidden property.

Manually trigger photo capture ​

The previous version (v5) offered a way to trigger photo capture by calling the .captureSelfie(); method. The current version (v6) does not support this feature and supports only automatic photo capture.

Turn off UI overlay elements ​

The previous version (v5) offered a way to turn off overlay by passing the showOverlay parameter in liqaConfig. The current version (v6) does not support this feature.

Select camera (front/back) ​

The previous version (v5) offered a way to switch cameras by passing the envMode parameter in liqaConfig. The current version (v6) supports both front and back cameras with a UI element to switch between them if the device has more than one camera. You can select what camera to start first by using Image Sources API.

Customize autocapture countdown ​

The previous version (v5) offered a way to customize the autocapture countdown by passing the useCountdown and countdownMaxTimeSeconds parameters in liqaConfig. The current version (v6) does not support this feature.

Select image encoding format ​

The previous version (v5) offered a way to select image encoding format by passing the imageFormat parameter in liqaConfig. The current version (v6) does not support this feature.

Collect facial keypoints (landmarks) ​

The previous version (v5) offered a way to collect facial keypoints by subscribing to .selfieLandmarks$ observable. The current version (v6) does not support this feature.

Exit LIQA session ​

The previous version (v5) offered a way to exit LIQA session by calling the .unmount() and .exit(); method. The current version (v6) does not support this feature.