Plug-in: overview

intro this page describes the functionality and features of our plug in the plug in is a fast, easy and seamless way to integrate intelliprove into your website or app while providing many customisation options it can be set up with just a few lines of code this article is the best place to get started as a developer and also contains useful information for ui/ux designers key features ✅ ensure a qualitative health check with clear instructions ✅ comes with a ready to use recording screen and incorporated quality check ✅ visualise the health insights using the optional, built in results view ✅ customise the look and feel of the ui to match your branding and ensure a seamless integration how it works the plug in solution is a web application that you can embed in your platform website or mobile app our web plug in docs docid\ f86cembkuj kwr60rtrev explain exactly how to do this this approach keeps the more complex interfacing behind the scenes but still allows full flexibility to decide when or where the health scan is performed on your platform you could place it in a section of your website, within a pop up, behind a button or within a collapsable element the ui theming of the web application can be fully customised , including primary and secondary colours, fonts, and logo this allows for a seamless integration of the application into your website or customer platform refer to the customisation docid\ rjgsa73gtgnctkq9ufeug page in the technical documentation to learn how to do this flow we've crafted the plug in with maximum user experience in mind it comes pre loaded with all the necessary features to effortlessly guide the user through the health check four different steps can be distinguished, each taking place in their own corresponding screen, as shown in the figure below welcome screen explaining to the user what the health check will do onboarding screen preparing the user to perform a qualitative measurement recording screen actual recording of the user's face to measure the biomarkers results screen displaying the results of the health check the flow is described in more detail below 1\ informing the user the flow starts with the welcome screen, which shows the distinct steps to perform the health check for the more inquisitive individuals, there's a "read more" option available if required, the user can change the language, which is, by default, taken over from the browser this page of the plug in is designed to be optional you can request to disable it in order to use a custom made one, tweaked to the user experience of your platform if you do decide to use the built in screen, refer to our customisation docid\ rjgsa73gtgnctkq9ufeug to learn how to customize the look and feel of the screen mandatory information while this screen can be disabled to design your own, it contains crucial information in case you do design your own, it is imperative to replicate the essential content on your custom information screen the following mandatory information must be displayed a message informing the user about the meaning of health check, with a link to a page where they can find more information a check box requesting the user's consent, in order to comply with applicable gdpr regulations 2\ onboarding clear onboarding instructions are essential for achieving a qualitative measurement when the user performs their first health check , an onboarding screen with four clear instructions is provided to ensure a qualitative measurement process the user can easily swipe or click through these instructions before starting the health scan recording after going through them, the user is welcomed by the recording screen 3\ performing the measurement we provide a ready to use recording screen equipped with all necessary tools to perform the actual measurement it includes brackets indicating where the user should keep their face integrated, real time quality checks with intuitive colour codes, that assist the user in finding the ideal position and optimal lighting conditions a flash function, to improve lighting when the ambient light is insufficient an option to re read the onboarding instructions the button to start the recording automatic product updates quality check when pressing the start button, the user's setup and the lighting conditions are first reviewed this check, also referred to as a ' quality check ', ensures that the recording setup meets our requirements for a qualitative measurement this includes, for example, checking if there is sufficient lighting, checking the face camera distance and analyzing the user's motion messages guide the user towards an ideal position and lighting once the check passes, the actual recording is started keep the technical requirements in mind for video recording see video input requirements docid 3ubjuaxicjgeicclkq13z 4\ results a comprehensive results screen is integrated into the plug in solution, featuring our biomarker buckets these buckets group the biomarkers into groups to allow insight into a given topic the content is further enhanced with ai generated feedback and a tip the biomarker outcomes are animated with colour coded indicators representing various levels clicking on the info button inside the biomarker box reveals more information about its meaning this page is optional, meaning that you can disable it and, if desired, replace it with a custom made one that is completely adjusted to your platform's user experience refer to our requesting results docid\ nhmyw3igywbv wbatholb to learn how to do this if you do decide to use the built in screen, refer to our customisation docid\ rjgsa73gtgnctkq9ufeug to learn how to customize the look and feel of the screen alternative flow some of our customers have a slightly different flow, which includes asking a few follow up questions after the measurement, before showing the health check results in this case, the results screen is disabled so that it isn't dispalyed right after the recording this is why we provide an api endpoint to request the url for just the results screen this can be used to display an iframe with the results screen at any point later on in the flow