1.4.17

Get Started

The Sybrin Onboarding Product can be used to implement a user onboarding journey that includes capture of all required user information. To implement the product, both the front end UI and the backend API have to be configured and hosted. In this section we will focus on how to get the Sybrin Onboarding Product hosted and ready for use.

Before you begin

Please ensure that you have acquired all required API keys and endpoints from Sybrin.

Please ensure that you have the following essential files (you may download these files from the Demo Application section):

  • Web UI

    • index.css

    • index.html

    • index.js

    • sybrin.onboarding.js

    • assets/haarcascade_eye.xml

    • assets/haarcascade_frontalface_default.xml

    • All files and folders under assets/samples

  • Backend API

    • All relevant DLL files

    • log4net.config

    • appsettings.release.json

    • Assets/Languages/en-us.json

    • Assets/Translations/en-us.xliff

    • Assets/Terms/en-us.html

    • Assets/Privacy/en-us.html

And the following optional files:

  • Web UI

    • index.css

    • index.html

    • index.js

  • Backend API

    • Assets/Languages

      • A JSON metadata entry for each additional language that you would like to support

    • Assets/Translations

      • An XLIFF translation file for each additional language that you would like to support

    • Assets/Terms

      • An HTML file detailing terms and conditions in each additional language that you would like to support

    • Assets/Privacy

      • An HTML file detailing the privacy policy in each additional language that you would like to support

If you are using Typescript, you may make use of the typings found under the src folder.

Backend API

You must have a DotNet-5-ready hosting environment of your choosing (such as IIS or Azure), with Redis installed, prepared beforehand.

Please ensure that you have all backend API files as listed above.

Deploy the files as a new web application on the hosting environment.

Set configuration options (as described in the Backend API section) in the appsettings file as desired.

Follow steps required to enable the web application for hosting as per the environment of your choosing.

Web UI

The web UI may be deployed on the same environment where the backend API is located, or on a separate environment.

If you choose to deploy the UI on a separate environment, please ensure that it is prepared beforehand.

Please ensure that you have all web UI files as listed above.

Deploy the files as a new site on the hosting environment.

Set configuration options (as described in the Web UI section) as desired.

Follow steps required to enable the site for hosting as per the environment of your choosing.

Done

You are now ready and all set up to use the Sybrin Onboarding product! Check out all the Onboarding features.

Last updated