Pointr Cloud Dashboard Embed Mode¶
Overview¶
This document outlines the integration of Pointr Cloud Dashboard to be embedded using an iframe.
The purpose of this document is to provide clear guidelines and instructions for the development team to ensure the successful integration of the embed mode.
Although the standard Pointr Cloud Dashboard is a standalone web application, it can be embedded directly, but this means the user will see the login page and after successful authentication can access all the data in the application.
The special embed mode allows the application to be embedded within another web application using an iframe with specific deployment options and configurations.
Embed mode does not require user to login, it is authenticated by the parent application and the parent application is responsible for providing the access token and refresh token to the embedded application which needs to be passed as query parameters in the URL.
Add access and refresh token as below
?access_token=<accessToken>&refresh_token=<refreshToken>
URL structure examples:
Clients Page: https://<Pointr Cloud Dashboard>/cms/content/clients?access_token=<accessToken>&refresh_token=<refreshToken>
Sites Page: https://<Pointr Cloud Dashboard>/cms/content/clients/<clientInternalIdentifier>/sites?access_token=<accessToken>&refresh_token=<refreshToken>
Buildings Page: https://<Pointr Cloud Dashboard>/cms/content/clients/<clientInternalIdentifier>/sites/<siteInternalIdentifier>/buildings?access_token=<accessToken>&refresh_token=<refreshToken>
Example iframe usage:
<iframe src="https://<Pointr Cloud Dashboard>/cms/content/clients?access_token=<accessToken>&refresh_token=<refreshToken>" title="Pointr Cloud Dashboard">
<iframe src="https://<Pointr Cloud Dashboard>/cms/content/clients/<clientInternalIdentifier>/sites?access_token=<accessToken>&refresh_token=<refreshToken>" title="Pointr Cloud Dashboard">
<iframe src="https://<Pointr Cloud Dashboard>/cms/content/clients/<clientInternalIdentifier>/sites/<siteInternalIdentifier>/buildings?access_token=<accessToken>&refresh_token=<refreshToken>" title="Pointr Cloud Dashboard">
The parent application is responsible for providing access and refresh tokens and also client/site/building internal identifiers if necessary to the embedded application.
These data can be obtained from the Pointr Cloud API and a valid embed URL can be constructed.
API References¶
-
Access token and refresh token can be obtained from the Pointr Cloud API using the following endpoint
-
Client/Site/Building internal identifiers can be obtained from the Pointr Cloud API using the following endpoints