Your API settings are accessed through the "Apps" view in "Settings". In order to gain access to "Apps" settings, you must have a "Paid" account subscription. You can upgrade your account type by navigating to the "Billing" view in "Settings".
Do not share your API keys - they can be used to access your account data, so be sure to keep them secret.
Authenticate your API requests by including your secret API key in your requests. API authentication is performed by assigning your secret API key to the X
-VECTIO-SK header for each HTTP request you make to Vectio's API.
User authentication is required for most API calls. In order to authenticate, make a POST request to
/auth/local with the user’s email and password. You will receive a token that should be used for subsequent requests. This token will specify an expiry date and time, after which the token must be refreshed by repeating these steps.
All API responses conform to HTTP codes. API responses are wrapped in the following format:
- data: JSON array or object containing the result (if any) of a request
- metadata: JSON object with additional information (such as paging) of a request
- links: contains links associated to the resource that was requested
All API errors conform to HTTP codes. API errors are sent as codes and wrapped in the following format when detail is provided:
- errors: JSON array containing errors due to this request
- source: JSON object with information about the source of the error
- title: user-friendly title regarding the error
- detail: user-friendly details regarding the error
The following resources can be accessed via HTTP methods when using Vectio's API:
- Company: manage the company's details
- User: individual user information and authentication
- Booking: order resource that can exist in different states in the user’s workflow
- Trip: resource to store driver, updates about any trips assigned to an order
- Driver: resource that represents a driver and related information
- Invoice: resource to store invoice information
Details about each of the resource's schema, methods available, and application logic are detailed in the API's technical specification, which will be made available in the 'Apps' section.