Articles in this section

AGORA API Doc

AGORA supports importing data over an HTTP-based API. It accepts the native export formats of various DMS systems to make it as simple as possible to create your own integration without needing to worry about adapting your data.

Authentication

All API requests are authenticated through HTTP Basic Authentication, in addition to an API key unique to your account.

Prerequisites

You must have an AGORA account in order to use the API. Further, an API key is required. This is only visible to the account administrator (normally, the user that created the account) and should only be shared with users you want to grant API access.

To retrieve your API key, click on your user name in the upper right portion of the application and select the 'User Settings' option. At the bottom of the screen you will find the API key for this account.

Testing the API

For all of our examples we will use cURL, a command-line utility for sending HTTP requests. If you do not have cURL the examples should be adaptable to whatever utility to prefer.

Remember to replace the username, password, API key, and path the the file with your information. If the upload succeeds you should receive a HTTP 202 Accepted response with a link in the body that will look like the following:

The errors field will contain information about each row that could not be processed if the status field is either PARTIAL_SUCCESS or FAIL.

Loan Status and Management

The AGORA API also allows you to find out information about the loans in your portfolio to help you make better use of the API. For example, if you only want to send loans that have changed since the last time an API call was made you can call this API and get the last upload date for each loan in AGORA, as well as the status of that loan:

Using the above API you can also deal with loans that are no longer in your DMS, such as when a loan is sold. If a loan is returned in an API call that is no longer in your system you can remove it like so: