Generate API Key

How to generate API keys

PME users can generate API keys to test the API from API documentation

  1. PME Users can select new Settings icon from top right side of the toolbar

  1. Select Key management menu from Settings : Settings > Integrations > Key management

  1. Click on Create New button

  2. Fill all fields and click on Generate button

  3. Copy generated 'Key' (Please note that after closing this window, User will not be allowed to copy the 'Key' )

  4. Close the window

  1. Created API key record will be displayed on record log page

  1. Right click on Actions button to Revoke the Key

  1. PME User is able to create 5 enabled /disabled keys per tenant

  1. Key will get expired after selected expiry date.

  2. Generated Key can be used as API Authentication Token

  3. Use of Key ID :In the backend, we convert the user Key to a Key ID, to verify its existence and then compare the Key ID with the hashed ID for validation. (Please note that we are not using 'Key ID' as API Authentication token)

Last updated

Was this helpful?