Request plug-in URL
To integrate the plug-in within your website or mobile app, 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.
If you haven't already, go through our product documentation to get a clear understanding of the plug-in flow and its features.
Requesting a temporary web plug-in URL 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.
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.
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.
Patient-ref - Recommended Add a unique reference to track which user ('patient') was been measured. This allows us to keep track of previous health scans of the patient and use these for long-term health trends. Take into account that this is required to obtain an outcome for the Mental Health Risk parameter. Make sure the 'patient reference' is a hashed, pseudonymized reference!
An example is provided here:
Performer-ref Add a unique reference to track who performed each measurement. This allows you to group measurements performed by a specific health professional or at a specific location on your website.
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, and include the user's ID in the patient-ref query parameter. 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!
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.