Appearance
API Reference Overview
CabFare Connect uses three separate API specifications that together define the complete integration. Understanding the relationship between these three APIs and the direction of communication is essential before implementing individual endpoints.
CabFare Connect APIHosted by CabFare. Called by both partners.Payment Terminal APIHosted by the Payment Terminal partner.Taxi Meter APIHosted by the Taxi Meter partner.
The Three APIs
CabFare Connect API
The central API hosted by CabFare. Both the Taxi Meter partner and the Payment Terminal partner call these endpoints to send events to CabFare Connect, initiate actions, and request subsidy calculations. This is the outbound communication path from your system to CabFare Connect.
Taxi Meter API
The endpoints your system must implement and host if you are a Taxi Meter partner. CabFare Connect calls these endpoints to deliver inbound event notifications to your Taxi Meter system — for example link requests, MPTP member data, and payment confirmations.
Payment Terminal API
The endpoints your system must implement and host if you are a Payment Terminal partner. CabFare Connect calls these endpoints to deliver inbound event notifications to your Payment Terminal system — for example card read requests, payment instructions, and driver logout notifications.
Communication Direction Summary
| API | Hosted By | Called By | Direction |
|---|---|---|---|
| CabFare Connect API | CabFare | Taxi Meter and Payment Terminal partners | Outbound — your system calls CabFare |
| Taxi Meter API | Taxi Meter partner | CabFare Connect | Inbound — CabFare calls your system |
| Payment Terminal API | Payment Terminal partner | CabFare Connect | Inbound — CabFare calls your system |
Which APIs Apply to You
If you are a Taxi Meter partner you must:
- Call the CabFare Connect API endpoints relevant to your persona
- Implement and host the Taxi Meter API endpoints
If you are a Payment Terminal partner you must:
- Call the CabFare Connect API endpoints relevant to your persona
- Implement and host the Payment Terminal API endpoints
API Versioning and Base URLs
The current API version is v0.5.0. See the Changelog for what changed in each version and the Versioning Policy for how long versions are supported. Base URLs are provided per environment and per location. Refer to the relevant location section for the base URL applicable to your integration.
Authentication
All API calls in both directions use the same X-API-KEY and X-API-SECRET headers. Refer to the Authentication and Security page in Core Concepts for full details.