Getting Started
Get up and running with our API quickly and start developing your HopDrive integration.
Step 1: Create an account with HopDrive
In order use the HopDrive API you must first be a HopDrive customer with established pricing. If you are not yet moving cars using our incredible HopDrivers, what are you waiting for? Contact our HopDrive Sales Team today to get signed up!
Step 2: Obtain your Client ID and Secret
If you haven't already, email the HopDrive Tech Team to secure a client_id and a client_secret for your customer id. If you aren't sure what your customer id is, just include your business name and location in the email and we will get in touch.
These keys will be used to authenticate you as a HopDrive customer to the API. The client_id is used to generate an authentication token will dictate which information is available to the calling system.
Step 3: Make your first API call
Now that you have credentials, you're ready to start using the API. Before we dive into authentication though, let's learn some basics.
Base Url
Since the API is organized around REST principles, the API has multiple endpoints that all build upon the following url:
https://api.hopdrive.com
Versions
The API supports versioning within the endpoints using the v1 or v2 syntax in the first position of the path. As of March 2021 only v1 exists.
https://api.hopdrive.com/v1/{resource}/{id}
Health Check
Make your first call to the API to check that it's online:
curl --request GET --url http://api.hopdrive.com/v1/health
The above call should return the following:
{
"message": "Ok"
}
That's it!
Now that you're all setup to use the HopDrive API, let's make some moves! Use the rest of this documentation to learn about all that you can do with your newfound capabilities. If you have any questions along the way, don't hesitate to reach out.