Third party LMS integration guide Overview
Provides guidance on how to send leads into Dealer Studio via API, including how to obtain important dealership identifiers, such as dealership ID and location ID
1. Request an API key
Section titled “1. Request an API key”Request an API key from Dealer Studio by emailing support@dealerstudio.com.au. Please also nominate which dealerships you would like included in your API key. One API key can include access to multiple dealerships.
Upon request, we can also provide access to a test dealership, which can be utilised as a sandbox environment to test the integration.
2. Consolidated endpoint for all relevant dealership level details
Section titled “2. Consolidated endpoint for all relevant dealership level details”Once the relevant dealerships are added to your API key, you can use the /api/v1/apikeys/apikey_details.json endpoint to return the below identifiers:
- Dealership locations
- Dealership users
Reference documentation: API key details
3. Leads Submission Endpoint
Section titled “3. Leads Submission Endpoint”Create and update leads using the dedicated API endpoint. When leads are created, they will be automatically “clustered” per customer. This is based on matching customer phone number or email address.
Reference documentation: Create Lead, Update Lead
4. Lead Events API
Section titled “4. Lead Events API”Leads can contain lead events, such as phone calls, sms events, emails or notes.
Reference documentation: Lead Events, Create lead event by service
5. Appointments API
Section titled “5. Appointments API”Reference documentation: Create appointment, Create appointment (by dealership)
6. Webhook Configuration
Section titled “6. Webhook Configuration”Setup webhook notifications in dealership settings under notifications to receive API updates. The ability to create webhooks programatically is not yet available.