Guides
Concepts and step-by-step tasks for integrating with Transferz. Start with Getting started, then follow your build path.
Start here
Getting started as a partner
Make your first call to the Transferz staging API from your own system. You need the onboarding email from Transferz. About 10 minutes.
Start here
Getting started as a transfer company
Make your first call to the Transferz staging API from your own system. You need the onboarding email from Transferz. About 10 minutes.
How the APIs work
- AuthenticationCreate an API key and send it in the X-API-Key header with every request.
- Environments and base URLsThe staging and production environments, and the base URL of each Transferz API.
- ConventionsDates and time zones, IDs, pagination, request IDs and rate limits across the Transferz APIs.
- ErrorsHow the Transferz APIs report errors, and the cause and remedy of each error code.
- ConstantsEvery journey status, vehicle category, add-on, cancellation reason and decline reason, with what each value means.
- Test data on stagingHow to get test journeys and bookings on staging, and how to trigger each scenario you need to test.
- Versioning and deprecationHow the Transferz APIs change over time, how deprecated fields are marked, and how to stay compatible.
- GlossaryThe terms used across the Transferz APIs and this portal, from booking to meeting point.