Introduction
This documentation is still under development and is subject to change without notice.
Capabilities#
The core capabilities of the Quatrix business platform are available through the API:
- Selecting a product (e.g Motorcycle, Pickup, Van, 3T, etc.)
- Specifying origin (pickup) and destination (dropoff) locations
- Viewing price and time estimates
- Placing an order
All production API requests are made to:
There is also a sandbox to use when developing and testing applications, with requests being made to:
The current version of the API is v1. Backwards incompatible changes will result in a version bump.
REST#
The Quatrix API is organized around REST. The API provides an interface for application to interact with a subset of functionalities available in Quatrix platform by sending and receiving data as JSON-encoded objects. Our API has predicatable resource-oriented URLs, and uses standard HTTP response codes, authentication, and verbs GET, POST, PUT, PATCH, & DELETE.
Authentication#
The Quatrix API uses API keys to authenticate requests. You can view and manage your API keys in your Quatrix business account settings.
Test mode (sandbox) secret keys have the prefix sktest and live mode secret keys have the prefix sklive.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via HTTP Bearer Auth. Provide your API key as the bearer auth value. Example using curl:
-H "Authorization: Bearer sk_test_B22plNndjNOwb6KgHZEUZZWxnwLRtdJO7ZENDf6fOHHRH8U3uXxABusN7MP2w1tS"All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.