---
title: Plug-in URL
slug: technical-docs/plug-in-url
icon: 🔗
docTags: 
createdAt: 2023-12-27T14:24:17.690Z
---

# Introduction

The [Plug-in components](docId\:djhYobp_3w-87jKk0o1Ho) are our solution for &#x61;**&#x20;fast way&#x20;**&#x74;o **integrate** Face Scans into your website or mobile app and obtain health insights quickly. We offer two components:

- **Face Scan plug-in** – mandatory, required to perform Face Scans&#x20;
- **Health Dashboard plug-in** –  optional,  provides a ready-to-use, intuitive interface that presents a user's health insights clearly and effortlessly.

::::VerticalSplit{layout="middle"}
:::VerticalSplitItem


![Face Scan Plug-in](https://api.archbee.com/api/optimize/_0R_DnpmBBLLXmaoWvG2u/v3Uo1vU0qG4fIgchM4Gly_image.png "Face Scan Plug-in")
:::

:::VerticalSplitItem


![Health Dashboard Plug-in](https://api.archbee.com/api/optimize/_0R_DnpmBBLLXmaoWvG2u/EURxeyLjot0N-38q56VTf_image.png "Health Dashboard Plug-in")
:::
::::

For an overview of the functionality and features included in our plug-ins, refer to the [Plug-in components](docId\:djhYobp_3w-87jKk0o1Ho) documentation .

To integrate these plug-ins within your website or 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.

# Prerequisites

To request a Face Scan URL, the user performing the scan must be registered with IntelliProve.&#x20;

:::hint{type="success"}
[→  Learn how to create a User](docId\:qghLDn2mLA8w9rpKEigWn)
:::

# Request URL

Requesting an authenticated URL for a plug-in to can be done with a simple HTTP GET call to the IntelliProve API.

:::hint{type="warning"}
Please note that this requires your IntelliProve API key. **Exposing this API key to the client side is bad practice.&#x20;**&#x59;ou should not incorporate the API key in your JS browser code. Instead, resolve the plug-in URL from a backend server.&#x20;
:::

- For the Face Scan plug-in, use the following endpoint: [Get Face Scan URL](docId\:BiuPVixvHltbukKLR2ATI)&#x20;
- For the Health Dashboard plug-in, use the following endpoint: [Get Health Dashboard URL](docId\:BiuPVixvHltbukKLR2ATI)&#x20;

You can paste the obtained Face Scan URL in your browser to play with the Face Scan and show off a first POC!

:::hint{type="warning"}
Keep in mind that these plug-ins are designed to be embedded in your application. For example, the **Continue** button shown after a scan completes, does nothing by default — but the click emits a post message, which your app can listen for to redirect to a new page, hide the plug-in, or trigger any other follow-up. The next steps explain how to do this.
:::

## When to request the plug-in URLs?

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.&#x20;

:::hint{type="warning"}
**Important**: make sure to refresh the iframe or webview when a user clicks to perform another scan, so that the session starts from the start.
:::

# Next steps

Now, that you understand how to request the plug-in URLs, it's time to embed the Face Scan plug-in component in your app. Continue with the [Embed Plug-in](docId\:RfjkpQXvJ2UCHau2iB184) documentation.



