Managing API Keys

Introduction

API keys can be used to integrate with the Open Assets system and are assigned permissions upon setup. The Key is a randomly generate string of characters that is encrypted and stored by Open Assets.

To understand the APIs available, please see the Developer Docs

API keys are listed in the Company Profile.

{image of api list}

i - Please note that the API key is only available to copy when first created. After this point, the key can only be referenced by the first set of characters.

Adding API Key

To add an API key click on the 'Add New' button.

{image of the api permissions}

Select which permissions the API key will allow and click 'Create'. These are defined at the bottom of this page.

A popup will show the API key which should be copied and stored securely to be used within API calls. Click 'Close' to close the popup and return to the API Key tab.

Removing API Key

Each API key can be removed by clicking the 'Delete' button.

{image of delete message}

Click 'Delete' to confirm you would like to delete the key or 'Cancel' to stop the deletion and return to the API key screen.

Once an API key has been removed, it will no longer be usable and will need to be replaced for all systems integrated using it.

Permission Definitions

• 3 - ApiKey.Manage = The ability to add and remove API keys through integrations.

• 4 - Company.Update = The ability to amend details stored on the company profile including Tags and Categories.

• 5 - Company.ViewUsers = The ability to view all users associated to your company.

• 6 - Company.UpdateUsers = The ability to amend and remove users associated to your company.

• 7 - Company.Invite = The ability to invite(add) users to your company.

• 8 - Asset.AuditView = The ability to view the audit history of any asset to your company.

• 9 - Asset.View = The ability to view assets associated to your company.

• 10 - Asset.Create = The ability create assets associated to your company.

• 11 - Asset.Search = The abilty to use the search functionality to identify asset details.

• 12 - Asset.Warnings.View = The ability to view warnings created by Due Diligence searches or system processes.

• 13 - Asset.Warnings.Dismiss = The ability to dismiss Warnings marked against Assets so they are no longer visible against the asset.

• 14 - Asset.MARS.DueDiligenceSearch = The ability to run a due diligence search on an asset using MARS agency. MARS data will required company configuration of profile and has an additional cost provided by MARs agency.