TABLE OF CONTENTS
Description
See API documentation here
Create and manage API Key information for programmatic connections with SoftLedger. With API Keys, you can authenticate with other systems to automate the send and receive of data between those systems. API Keys are required for utilizing integrations within the SoftLedger Marketplace, as well as any other integration outside of the marketplace. If you have been provisioned API Keys in your subscription, you will be able to complete Keys in this page without the need to gather the Client ID, Client Secret, etc. from SoftLedger support team, increasing flexibility and security for your processes.
Additionally, the API Keys can be created with fine grained permissions, decreasing scope of each Key and therefore limiting risk involved with generating full access Keys. Lastly, you can also control which users within SoftLedger have access to be able to obtain API Key information.
Managing Keys
Creating Key
Note: If you have not contacted SoftLedger support team to allow for Key creation to be in line with your subscription, you will be blocked from creating new Keys.
Keys can be created from the API Keys page, housed under the Admin module by clicking +New and then naming and determining permissions for the new API Key, as per the image below:
Fields
- Name - Must be unique, and more than 5 characters
- Permissions - At least one permission is required
Key Secret
Note: After submitting a Key for creation, you will be able to view the API Key's client_secret value ONLY ONE TIME. If you fail to record the secret it CANNOT be recovered and you will need to create a new Key.
Once you create the Key with secret, be sure to copy the secret for use with other applications.
Managing Keys
Once you have created Keys from the steps above, they can be viewed under the Admin ➝ Api Keys section, where you can edit and delete them.
Deleting a Key
Keys can be deleted from the row action menu one by one, or in bulk by selecting multiple from the far left checkboxes:
You will be prompted to confirm deletion. When a Key is deleted, you will no longer be able to generate access tokens from it. Existing access tokens will still work until their expiry time (24 hours)
Modifying Permissions
API Key permissions may be modified by clicking into the Edit icon from the row actions menu:
