Getting started
Welcome to Voi's partner documentation. This site contains everything you need to integrate with Voi — from read-only data feeds to full Mobility-as-a-Service journeys.
Choose your integration
| Integration | What it is | Good for |
|---|---|---|
| Light integration | A read-only API with MDS, GBFS and Zone data | Journey planners, transit apps, data sharing |
| Deep integration | A MaaS API to complete full user journeys (register, rent, end, pay) | Apps that let users ride Voi vehicles |
| TOMP | The standardised TOMP v1.6.1 API for deep integrations | MaaS platforms that already speak TOMP |
The Deep integration and TOMP references include an interactive Try it console — paste your API key and call the live staging or production API straight from the docs.
Authentication
All Voi partner APIs are protected with API-key authentication. Include your key
in the X-Access-Token request header on every request:
curl "https://partners.voiapp.io/v1/zone/info" \
-H "X-Access-Token: $API_KEY"
Contact our engineering support to receive an API key for staging or production.
Environments
| API | Staging | Production |
|---|---|---|
| Deep integration (MaaS) | https://partners.stage.voiapp.io | https://partners.voiapp.io |
| TOMP | https://api.stage.voiapp.io/edge/tomp | https://api.voiapp.io/edge/tomp |
| Light (MDS/GBFS) | — | https://api.voiapp.io |
In staging we provide virtual scooters located in Berlin so you can build and test before going live.
Next steps
- Pick an integration type above and follow its checklist.
- Request a staging API key from your point of contact.
- Build and test against staging.
- Request production access and launch.