API key
Route optimisation uses this. Send the key in the api-key header on every request. Every route optimisation endpoint in this documentation takes an API key and never a bearer token.
api-key: YOUR_KEYAPI documentation
These are the endpoint groups intended for integration partners. The documentation is generated from a version-pinned OpenAPI snapshot and never calls the live operational system.
Scope of this documentation
This site publishes partner-facing endpoint groups only. Anything belonging to internal TMS operations is outside the public documentation and will not appear here.
Authentication
Which scheme applies depends on the endpoint group, not on your key. Every operation page states what it accepts, under authentication required.
JWT token
The other groups use this. Send the token in the Authorization header as a Bearer token. Tour planning accepts either.
Authorization: Bearer YOUR_TOKENWhat a key needs before route optimisation will answer
Three things have to be true at once. If any one of them is not, the request is refused, and the code you get back is in the error section below.
- The key is valid and has not expired.
- The key has been given Route optimization access. That is granted per key by the Route4Green team and is not something you can enable yourself.
- The feature is switched on server side. That is a global switch rather than a per account setting, so a fully entitled key can still be refused.
Never put a key in code that runs in a browser or a mobile app. Keys belong on your own server.
How to get a key
Not by yourself, yet. Keys are minted inside the partner portal and that requires a signed in session, so there is no self service path for a developer. Request a trial and we will issue a test key by hand if your operation fits.
Request a trialA self service portal and a test environment are planned. Neither has a release date.
Base URL
There is a single base URL, issued along with your key. The paths in this documentation are appended to it.
The test and production environments share that base URL and are told apart by the key you send, not by a different path. Switching environment means switching key, not reconfiguring a host.
Endpoint groups
8 groups
Route optimisation
Create optimisation jobs, track their status, and read results. This is the core of Route4Green.
7 endpoints
Tour planning
Create and adjust daily tour plans, assigning vehicles and drivers to runs.
6 endpoints
Orders
Push orders and drop points into the system so they enter the optimisation problem.
7 endpoints
Request pools
Pool transport requests so the optimisation core can decide how to combine them.
5 endpoints
Vehicles
Declare vehicles, payloads, and the operating attributes of your fleet.
6 endpoints
Vehicle plans
Per-vehicle availability, so results match the fleet you actually have.
7 endpoints
Webhooks
Subscribe to events instead of polling for them.
5 endpoints
API keys
Create, list, and revoke access keys per integration.
3 endpoints
Guides and SDK
5 pages
The five guides below are written for integrators. A packaged SDK is planned and not released, so each page shows how to do the same thing over plain HTTP, which works today.
Install
There is no package to install. Generate a client from the downloadable specification.
Quickstart
Submit a job and collect the result, end to end.
Authentication
Send the key in the api-key header.
Handling async jobs
Six states, four of them terminal, and when to stop.
Verifying webhooks
Verify before you trust, and verify against the raw body.
About this specification
This documentation is generated from a stored and reviewed OpenAPI snapshot, last updated on the date below. We do not fetch a fresh copy automatically, so a new internal endpoint added upstream cannot leak onto this site by accident.
Updated
Download the partner specification
The JSON below contains exactly the endpoints that appear in this documentation, plus the data shapes they reference. Internal operations are filtered out rather than hidden, so you can feed this straight to a generator.
Download the JSON
46 endpoints in the file