​
Developer Guides

Buy

Buy, includes checkout and payment processing. Creating customers and orders.

Sell

Sell, includes inventory management, listing, and pricing. Creating and managing listings.

Trade

Trade, includes trade-in valuation and processing. Creating and managing trade-ins.

Broker

Broker, includes vehicle sourcing and selling. Creating and managing brokered vehicles.

Dropship

Dropship, includes vehicle selling and delivery. Creating and managing dropship orders.

​
Best Practices

Learn about best practices for using the Drivly SDK, API, and more.

​
Use sandbox for testing

The sandbox environment is a great way to test your integration with the Drivly API. It allows you to test your integration without affecting your production data.

Our upstream providers require that testing be done strictly inside the sandbox, as to not affect any real-world data.

The production API effects real-world data, testing in production can lead to a suspension of your account.

​
Avoid caching

Our APIs are designed to be fast and reliable. However, caching the results of API calls can lead to stale data being reported to your customers, users, and staff. We recommend that you avoid caching the results of API calls, or if you must cache, use a short cache time.

​
Use the latest version of the SDK

We are constantly improving the Drivly SDK. To take advantage of the latest features and improvements, always use the latest version of the SDK.

​
Authentication

API keys are used to authenticate requests to our APIs, and are required for all requests. You can create and manage your API keys in the Dashboard.

​
Why use an API key?

API keys are used to authenticate requests to our APIs. They allow us to track and manage your application’s access to our APIs, as well as assist in support if you encounter any issues.

​
Best practices for API key security

  • Keep your API keys private: Treat them as sensitive data and avoid exposing them in public repositories, client-side code, or anywhere they could be accessed by unauthorized individuals.
  • Use environment variables: Store API keys in environment variables or secure app settings to keep them secure.
  • Rotate keys regularly: Periodically change API keys to minimize the risk of old keys being misused.
  • Apply least privilege: Grant the minimum permissions necessary for the key to function, reducing the potential impact of a compromised key.

By following these guidelines and using API keys effectively, you can enhance the security and efficiency of your application’s interaction with our APIs.