API Access
Scarlett Mortgage has open API for anyone who wishes to build integration into a third party service. This section is designed to provide the instruction & information required for developers to work on these integrations.
Obtaining Access Key
1) From within your Scarlett Mortgage account, navigate to Settings and select "API Access".
2) This will open the API access screen. Click "Create API Key"
3) Now name your key and select the type of data you wish to access. You can apply this key just to your account, or for any team(s) or individual agent(s) for which you have access.
4) The API Key will now be generated. Once you click "OK" on this box, you will not be able to view the key again, so be sure you have it saved securely.
The API Access panel will also show you keys created and the date they were last used. You can also revoke API keys from this location.
Developer Help Library
Our API Help library can be found here: https://api.scarlettnetwork.net/help
Some of the more common functions are found below.
Endpoints
https://api.scarlettnetwork.com
Pull
POST /dosconnect/deal-pull
Body
Parameter | Data type | Description |
APIKey | string |
|
From | Date | Last modified date |
To | Date | YYYY-MM-DD, 7 days |
Response
Parameter | Data Type | Description |
ReturnStatus.ReturnCode | Int | HTTP Status |
Deals | List<deal model> |
Push
POST /dosconnect/deal-push
Body
Parameter | Data Type | Description |
APIKey | String |
|
FirmCode | String |
|
ExpertLogin | String |
|
Deal | Deal model |
Dropdowns
Post /dosconnect/dropdown-pull
Body
Parameter | Data Type | Description |
APIKey | String |
|