Connecting to the API

Clients

To test your connection to LoanPro's API, you’ll need to use an HTTP client—an application on your computer that will send HTTP requests. If you want to send requests to the API without writing code, a REST client will work, since REST clients are HTTP clients with a graphical user interface and helpful tools. Some popular REST clients are Postman and Insomnia, and we recommend using either of them.

Alternately, you could use command-line utilities (such as cURL) or an HTTP library for your chosen programming language, if available. We’ll show the raw HTTP requests so that you can translate them to the language of your choice.

If you aren’t using one of our supported languages, we recommend taking some time to understand the structure of an HTTP request so you can understand what's going on in our HTTP samples. Some good resources for this include TutorialsPoint, Udacity, MDN Web Docs and Codecademy. We also recommend referring to your HTTP client’s documentation for configuration, as many have tutorials on how to send a sample request.

📘

LoanPro uses TLS 1.2 to encrypt communications. When selecting an HTTP client, make sure it’s compatible with TLS 1.2.

Once you have configured your client of choice, it’s time to get your API credentials.

API Credentials

If you haven't already, you can generate your API authentication information by navigating to Settings > Company > API > Overview within your LoanPro account.

To configure your API access, click 'Do it now.'

You’ll then be presented with a pop-up similar to the example shown above. Use the drop-down menu to select an agent user to associate with API access and actions.

📘

You can activate multiple API keys for your LoanPro account. API keys are associated with your agent users, and there's no limit to how many valid keys you can have at a time. To learn more about LoanPro's API keys, take a look at our Multiple Tenant API Keys article.

The agent user you select will be associated with every action completed through API calls. This will be shown in system notes, reports, timestamps, etc.

Click 'Save' to confirm your selection.

A successful configuration will result in your new authentication information being shown within your account settings.