Dealer Edit Pro ⋅ API Documentation
Welcome to the API documentation for Dealer Edit Pro. This documentation is intended for developers who wish to integrate with the Dealer Edit Pro API.
Our team will provide login credentials for this portal to allow you to create applications and review your API requests.
Authentication
OAuth 2.0 is currently the only supported method of authentication.
We recommend adding a shortcut button to your application that will allow you to quickly redirect to your app's authorization page.
An example of your authorization URL is as follows:
GET https://portal.autocartel.com/oauth/authorize?client_id={CLIENT_ID}&response_type=code&redirect_uri={REDIRECT_URI}
The portal will redirect back to your system with a code parameter in the URL:
{REDIRECT_URI}?code=1234567890asdfghjkl
You will exchange this code to receive your access and refresh token. The endpoint and required parameters for the exchange is:
POST https://portal.autocartel.com/oauth/token
- grant_type=authorization_code
- client_id={CLIENT_ID}
- client_secret={CLIENT_SECRET}
- redirect_uri={REDIRECT_URI}
- code={CODE}
The access token will be used as a Bearer token in the Authorization header for all requests to the API.
We recommend refreshing the token daily for security. The current expiration for access tokens is set to 3 days and refresh tokens are set to 7 days.
To refresh tokens, the format is:
POST https://portal.autocartel.com/oauth/token
- grant_type=refresh_token
- client_id={CLIENT_ID}
- client_secret={CLIENT_SECRET}
- redirect_uri={REDIRECT_URI}
- refresh_token={CODE}
Endpoints
The API is available at https://portal.autocartel.com/v1
. You can use the /health
endpoint to check the status of the API.
Currently, there is one endpoint available for processing photos: /v1/background
. The endpoint accepts a POST request with the following parameters:
-
photo_url
- The photo to be processed. This should be a JPG file. -
background_url
- The background photo to be used. This should be a JPG file. -
horizontal_percentage
- The horizontal position the vehicle needs to be in the photo i.e. "50" to center it. -
vertical_percentage
- The vertical position the vehicle needs to be in the photo i.e. "80" to bring it close to the bottom of the background photo. -
scale_percentage
- The scale of the vehicle in the photo.
The access token should be passed through the Authorization
header as a Bearer {token}
.