Introduction to Authentication

Request API Credentials

Get Your API Keys

To use Dealerware's API, you must first obtain your Client ID and Client Secret from our support team. If you have not yet received these credentials, please contact us at partnersupport@dealerware.com.

Keep Your API Keys Secure

Your API keys are the gateway to our services, so it's crucial to keep them confidential. Never expose your Client ID or Secret in public-facing areas, including version control systems, client-side code, or shared documents. Treat them as sensitive information.

How Our Security Works

Dealerware's API leverages an Access Token for authentication, generated securely by our partner authentication service. If a request is missing or has an invalid Access Token, it will be rejected, resulting in an authentication error.

The diagram below illustrates the authentication sequence:

Authentication Flow

Your client application submits its credentials (Client ID & Client Secret) to the Authorization Server.
The Authorization Server validates your application's credentials.
Upon successful validation, it issues an Access Token in JSON Web Token (JWT) format.
Your application uses this Access Token to make requests to the Dealerware API.
If the token is valid, the Dealerware API processes the request and returns the requested data.

Making API Requests

Use HTTPS for all API requests to ensure secure data transmission.
Your Client Identity carries access permissions for many of Dealerware's resources. Handle it with care and keep it private.
API authentication is handled through the Bearer Authentication method, which should be included in the Authorization header of your API requests.

Authenticating Your Application

Once you have your Client ID and Client Secret, direct the initial request to our authentication server: dealerware.auth0.com. This step should NOT involve api.dealerware.com. Provide your credentials as specified.

Subsequent calls to the Dealerware API only require the Access Token received from the Authorization Server. You do not need to resend your Client ID or Client Secret after initial authentication.

For further assistance, please visit our online help desk or reach out via email at partnersupport@dealerware.com.