API
The Integrations API allows you to extract data from Poly Lens and use your code to modify it. See the following to create an API connection.
Add an API Connection
- Go to the ACCOUNT menu > Manage Accounts.
- Select an Account from the list.
- Select Integrations > API from the side tabs.
- Select Create API Connection.
- Enter a Name and Role. Select Confirm.
- This new connection will populate the Integrations API list.
For each API Connection
Field | Description |
---|---|
Name | The API Connection Name is the name assigned to this connection and it a link to the Sample Code. |
Client ID | The Client ID can be copied to the clipboard to insert into the code. |
Secret | The Secret viewed and copied to the clipboard to use as the client_secret in the code. |
Date Created | Displays the date the API Connection was created. |
Role | Displays the Role assigned to the API Connection. Note: The Role can be modified in this field. |
Edit an API Connection
- Go to the ACCOUNT menu > Manage Accounts.
- Select an Account from the list.
- Select Integrations > API from the side tabs.
- Select an API connection from the list (this enables the Edit button).
- Select Edit.
- Edit the connection as needed and select Confirm.
Delete an API Connection
- Go to the ACCOUNT menu > Manage Accounts.
- Select an Account from the list.
- Select Integrations > API from the side tabs.
- Select an API connection from the list (this enables the Delete button).
- Select Delete.
- Select Delete to confirm. The API Connection is deleted from the list.
Sample Code
To display sample code for this API Connection.
- Go to the ACCOUNT menu > Manage Accounts.
- Select an Account from the list.
- Select Integrations > API from the side tabs.
- Select the Name of a Connection API from the list.
- This opens a popup with Sample Code to assist you with the process.
Note: The Sample Code can be copied to the clipboard for use in your code.