Forestreet can be integrated into your internal applications using an iFrame. This allows you to use Forestreet’s features within your existing applications without needing to build a separate UI. An iFrame integration is possible with the following steps:
1

Create a login session with your API Key

Your application backend should call the GET /v2/auth/session endpoint to create a timed session with your API Key. This will return a session ID token.

Do not perform this step on the client-side, as it exposes your API Key. Always ensure that this step is performed securely on the server-side.

Forestreet reserves the right to revoke API Keys that are suspected to have leaked.

2

Embed the iFrame

Your application backend then embeds an iFrame in your application frontend, with the Session ID appended to the URL as a query parameter. The URL should look like this:
iframe-integration.html
<iframe
  src="https://ailsa.forestreet.com/path/to/page?sessionId=<session_id>"
  width="100%"
  height="600px"
  frameborder="0"
/>
3

Use the iFrame

The iFrame will load the Forestreet application, using the timed session to authenticate the user. Authentications for any subsequent requests within the iFrame will be handled automatically by Forestreet’s frontend.

​
Pages suitable for iFrame integration

These are common pages that can be embedded in an iFrame: