Introduction

This guide shows you how to use the WEB API Endpoints to manage and access Loan Applications in DealerAlly.

URLs

The following are the base URLs for our environments:

• Integration/Staging: https://stg.dealerallyapi.com/v1

• Production: https://prod.dealerallyapi.com/v1

API Key Authorization

In order to access the API, all endpoints require the use of an API Key. The key should be added into the headers list of each endpoint:

"x-api-key" : "XYYYXxyyxXYYXxxxXXxxXXX"

This key will be provided by DealerAlly.

API Versioning

The API is versioned with URL prefixes: /v1/application, /v2/application.

A new version of the API will only be released for breaking changes. The following are considered breaking changes:

• Removing an endpoint.

• Removing a property from a response model.

• Adding a required property to a request model.

The following types of changes are not considered breaking changes:

• Adding a new endpoint.

• Adding a new property to a response model.

• Adding new optional query string o header parameters.

These lists aren't exhaustive, but illustrate the idea that if a change can be supported in an existing version, then a new version is not required.