Skip to main content

Introduction

The HopDrive API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the HopDrive API to request vehicle moves from a HopDriver through a system integration instead of having to input each move manually into the Dealer Portal.

You can use the HopDrive API in a test environment as well, which does not affect your live dealer portal and thus will not dispatch a driver to the location. The API key you use to authenticate the request determines whether the request is live mode or test mode.

Features#

  • ✅ Authenticate by single unique customer
  • ✅ Create one way move
  • ✅ Create round trip move
  • ✅ Create concierge move
  • ✅ Create concierge plus loaner move
  • ✅ Get move by id
  • 🔲 Get current location of driver for a move
  • 🔲 Get vehicle images from moves
  • ✅ Request that a move be cancelled
  • 🔲 List moves by criteria
  • 🔲 Get lane by id
  • 🔲 Get location by id
  • 🔲 Favorite a location
  • 🔲 Favorite a lane
  • ✅ Send move events via webhooks (partial)
  • 🔲 Provide self-service webhook registration
  • 🔲 Authenticate by customer group