Skip to main content

Syndication Through API

Syndication through API is the process where HeyAuto receives your syndicated inventory through an external GET API request which provides HeyAuto with your inventory data.

Setting up API integration with HeyAuto

If HeyAuto is accessing your API for the first time, please share the API documentation, API host location, and any necessary credentials with HeyAutos technical support team. We will then establish a connection to your provided API.

API data requirements and best practices

The data retrieved from the API should align with the Data Requirements specified in this documentation. While the attribute naming in the API's returned data doesn't need to match HeyAutos attribute names, it must be documented in your own documentation to ensure a smooth transformation process. The API response should provide the complete active inventory of a single dealership. If you are unable to meet this requirement, please contact HeyAutos technical support for assistance.

API for multiple dealerships

If your API serves multiple dealerships, it must have filter parameters in place to retrieve the inventory of a single dealership at a time.

Syndicating a new dealership through an existing API

If your API is already syndicated with HeyAuto and you need to add a new dealership's inventory, please contact HeyAutos technical support team at it@heyauto.com with the details of the new dealership and their dealership ID.

API Timing Requirements

To maintain efficient syndication, your API should respond within 10 seconds of a request. Requests exceeding this time limit will be considered failed, and inventory data won't be accepted. For assistance or inquiries, please contact HeyAutos technical support at it@heyauto.com.