API Integration

Introduction

The LoanPro API is built on top of OData, a prominent REST framework. The LoanPro API only accepts JSON objects in bodies of POST and PUT requests.

A complete list of all LoanPro endpoints can be located at https://loanpro.simnang.com/restler2/index.html.

To use the API you will need an API Token for your company. This token is generated inside Settings > Company > API > Overview.

This token gives unrestricted access to any available endpoints, so guard it with care! LoanPro will not be responsible for any damages caused by your negligence in the security of your API Token. 

Obtaining Your API Token

To obtain the API token for your company, navigate to Settings > Company > API > Overview inside your company’s account.

If you haven't set up API integration yet, click the Do it now link.

Select one of the Agent Users from within your company from the drop-down. Any agent user that has not signed the SaaS agreement will not show up on this list. Simply have that agent login and sign the SaaS agreement in order to add them. The agreement pops up immediately upon entering the company account. This Agent User will be associated with every action that is done through API calls. This will be shown within system notes, reports, time/date stamps, etc. It is recommended that you create a new agent user for this purpose so you can differentiate actions that occurred though the API.

Once you have selected the Agent User, click  .

Your API token is now generated. Guard the API token, because it will give access to your company data. The token is only visible to admin users inside your company.

If you have multiple tenants (production, sandbox, test), it is required that you create an agent user for each tenant and assign that agent as your API user. Every action performed via the API will be recorded in the system notes. The assigned API agent user will be the recorded user for these actions.

When creating API agent users, we recommend using the following naming convention for their assigned email addresses:

  • Production tenant – ProductionAPI@companyname.com
  • Sandbox tenant – SandboxAPI@companyname.com
  • Test tenant – TestAPI@company@companyname.com

Domain & Key Rotation

Domain

In order to maintain security, you must enter the top-level domain for the server from which API requests will originate. This should be formatted as https://simnang.com

Entering your server domain is required. Requests to the API will receive a 401 response if you have not entered it.

Key Rotation

You also have the option to allow LoanPro to regularly cycle your keys. This will make your API connection more secure, but you must update the keys within your code each time they change.


How did we do?


Powered by HelpDocs (opens in a new tab)