Initial integration
Plug-in URL

Introduction
The Plug-in﻿ component is our solution for a fast way to integrate the Face Scan﻿ into your website or mobile app and obtain health insights quickly. For an overview of the functionality and features of the Plug-in, refer to the Plug-in Solution﻿ documentatoin.
To integrate the plug-in within your website or app and perform Face Scans﻿, you will need a temporary authenticated URL.
Example
https://plugin.intelliprove.com?action_token=<action_token>&patient=<patient>
Validity
The action token embedded in the URL has a fixed expiry time. Currently, this is set to 6 hours, meaning the URL will no longer be valid after that. A new temporary URL should be requested after expiring.
Prerequisites
To request a Face Scan URL, the user performing the scan must be registered with IntelliProve. 
﻿→  Register a new user with IntelliProve﻿﻿
Request URL
Requesting an authenticated URL for the plug-in to can be done with a simple HTTP GET call to the IntelliProve API.
Please note that this step requires a valid IntelliProve API key. Exposing this API key to the client side is bad practice. You should not incorporate the API key in your JS browser code. Instead, resolve the plug-in URL from a backend server.
Get the Face Scan URL for a specific user based on the user ID or external user reference.
GET
Request
Query Parameters
user_id
optional
String
Unique ID of the user to perform the Face Scan for
external_user_id
optional
String
External user reference value
language
optional
String
Two-letter language code for overriding user-level preferred language
Header Parameters
x-api-key
required
String
Customer API key
Request Body

Responses
200
"<FACE_SCAN_IFRAME_URL>"

// e.g.: https://plugin.intelliprove.com/#/measurement/result/%3CUUID%3E?action_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImVtYWlsIjoiIiwiY3VzdG9tZXIiOiJ0ZXN0aW5nLWFwaS1rZXkiLCJncm91cCI6InN1cGVyLWFkbWluIiwibWF4X21lYXN1cmVtZW50X2NvdZ50IjoxMDAwMH0sIm1ldGEiOnt9LCJleHAiOjE3MDE4MjA4MDB9.CMVqCq2yFufk6oVnLbMqCW6eOc3CNjLTyR4oUyGdvdE
"<FACE_SCAN_IFRAME_URL>"

// e.g.: https://plugin.intelliprove.com/#/measurement/result/%3CUUID%3E?action_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImVtYWlsIjoiIiwiY3VzdG9tZXIiOiJ0ZXN0aW5nLWFwaS1rZXkiLCJncm91cCI6InN1cGVyLWFkbWluIiwibWF4X21lYXN1cmVtZW50X2NvdZ50IjoxMDAwMH0sIm1ldGEiOnt9LCJleHAiOjE3MDE4MjA4MDB9.CMVqCq2yFufk6oVnLbMqCW6eOc3CNjLTyR4oUyGdvdE
﻿
Please be aware that the URL provided in the response is subject to change. This involves not just the action token part, which varies with each new request, but also the subdomain of the URL, which may change when new versions of the plugin are released. Consequently, make sure not to hardcode any elements of this URL. Instead, consistently utilize the entire response URL as obtained.
﻿
Additional Query Parameters
The web plug-in URL allows adding additional session parameters via query parameters. These parameters are not mandatory but are recommended for enhanced functionality.
Language
Specify the language to allow the web plug-in to default to your preferred locale. The language code should consist of a two-letter language code.
The currently supported languages are "en" (English, default) and "nl" (Dutch). Please contact us if other languages should be supported.
When to request the URL?
It's a good practice to request a new URL for every new session initiated, i.e., every new end-user logging into your platform. For each new session, ensure to request a new URL via our API. Once generated, the same URL can be used for the same user for up to 6 hours, after which a new request will be necessary.
You can paste the obtained URL in your browser to play with the health scan and show off a first POC!
Next steps
Now, that you understand how to request the plug-in URL, it's time to embed the plug-in component in your app. Continue with the Embed Plug-in﻿ documentation.
﻿
Updated 17 Dec 2024
Initial integration
Embed Plug-in