API Key Management
Learn how to create and manage API keys.
Looking to get started as quickly as possible?
View our Quickstart Guide ↗
LoanPro's Loan Management System (LMS) allows users to generate multiple API keys per environment. Each key is associated with a user profile and adopts the access and role settings assigned to the user—providing the ability to grant granular access to specific API actions. In addition to access settings, LoanPro's key management tools help keep your API keys organized and fresh by providing regeneration and labeling options.
Keep reading to learn more about key creation and management.
Key creation
Start by navigating to Settings > Company > API > Overview within your LoanPro environment. Next, enable API access if it hasn't been enabled already. Following that, complete the following steps to create a new API key:
The list of available agents when creating a new API key will be limited to the agent users who have logged in and signed the LoanPro usage agreement.
When selecting a user to associate with the key, keep in mind that the user's access settings extend to API usage. LoanPro's Role-Based Access feature grants users access to specific pages and buttons within the software. This extends to API usage as well by granting users access to specific endpoints and methods. For example, a Role might grant users access to only GET requests made to the /Loans and /Customers endpoints. To learn more about Role-Based Access, see Creating Agent User-based Access ↗
Created keys are listed within the results of the API Overview page. Here's a breakdown of the information that describes each key:
| Column Name | Description |
|---|---|
| API Key | The authentication key used for API requests. |
| Username | The email address of the agent user associated with the key. |
| Title | An optional, customizable label that helps describe the key. This can be used to describe the purpose of the key, where it might be used in integrations, a description of its access, and more. |
| Role | The name of the role assigned to the agent user. |
Lastly, multiple keys can be associated with a single user. However, creating multiple keys for a single user is not recommended, as determining the origin of requests will become more difficult.
Key management
Once keys are created, they can be managed via the API Overview page. Click the three-dot menu icon to manage an individual's API key.
The following management tools can be used to ensure keys remain organized, secure, and fresh:
| Action | Description |
|---|---|
| Regenerate | Generates a new key for the same user. |
| Disable | Temporarily disables the key. Disabling a key will result in 401 Authentication Error responses. Keys can be reenabled. |
| Delete | Deletes a key permanently. Proceed with caution—this action cannot be undone. |
Updated 15 days ago