# Installation & Setup

### Q1. What is CabFare Connect and who is it for?

CabFare Connect is a middleware integration platform that brokers communication between Taxi Meter systems, Payment Terminals, and government Subsidy Providers. It enables both parties to process government subsidy schemes without building custom one-to-one integrations. It is designed for:

- Taxi meter and dispatch system vendors
- Payment terminal and mobile payment application providers
- Fleet operators who require compliant subsidy scheme processing

***

### Q2. What are the technical prerequisites for integrating with CabFare Connect?

To integrate you need:

- The ability to call HTTPS JSON APIs from your Taxi Meter or Payment Terminal platform
- Stable network access from vehicles — 4G, 5G, Wi-Fi, or tethering
- A unique and stable identifier for each Taxi Meter (`taxiMeterId`) and Payment Terminal (`terminalId`)
- Driver identifiers and vehicle plates for shift management
- API credentials (`X-API-KEY` and `X-API-SECRET`) issued by CabFare

No SDK is required. You integrate directly with the REST-style API using standard HTTPS JSON requests.

***

### Q3. How do I obtain sandbox and production API credentials?

Contact the CabFare integration team at [support@cabfare.com](mailto:support@cabfare.com) to register as an integration partner. After an initial onboarding and use-case review you will receive:

- Sandbox base URL and sandbox credentials
- Access to test data and sandbox scenarios for your location
- A certification process for promotion to production credentials

For security reasons credentials are not available through self-service or shared via public channels.

***

### Q4. How do I link a Taxi Meter and a Payment Terminal for a driver's shift?

Linking is achieved through a combination of login and link events:

1. The driver logs in on the Taxi Meter — `POST /meter/driver/login` with `taxiMeterId`, `driverId`, `vehiclePlate`
2. The driver logs in on the Payment Terminal — `POST /terminal/driver/login` with `terminalId`, `driverId`
3. The Payment Terminal sends a link request — `POST /terminal/link/request`
4. CabFare Connect forwards the link request to the Taxi Meter
5. On success both devices enter linked mode

Once both devices show `loginStatus: true` and `linkStatus: true` CabFare Connect will broker trip and payment events between them for that driver and vehicle. Refer to the Shift Start workflow for the full step-by-step.

***

### Q5. Do I need to implement all endpoints to go live?

No. The minimum endpoints required for a basic integration are:

**Taxi Meter partner:**

- `POST /meter/driver/login` and `POST /meter/driver/logout`
- `POST /meter/trip/start` and `POST /meter/trip/end`
- `POST /meter/job/done`
- `POST /meter/mptp/read` and `POST /meter/mptp/validate` for Subsidy Scheme trips
- Host `POST /link/request`, `POST /mptp/member`, `POST /payment/complete`, `POST /driver/logout`

**Payment Terminal partner:**

- `POST /terminal/driver/login` and `POST /terminal/driver/logout`
- `POST /terminal/link/request`
- `POST /terminal/mptp/validate`
- `POST /terminal/payment/complete`
- Host `POST /link/response`, `POST /mptp/read`, `POST /payment/request`, `POST /driver/logout`

Using the poll endpoints (`/meter/driver/poll` and `/terminal/driver/poll`) is recommended as they simplify status recovery after connectivity loss.

***

### Q6. Can CabFare Connect support multiple fleets under a single integration?

Yes. The Taxi Meter provider can integrate once with CabFare Connect and use client-defined key-value pairs (`clientIds`) to isolate different fleets. This allows a single integration to manage multiple fleets while keeping their data and operations distinct within CabFare Connect. Refer to the Fleet Isolation Using Client IDs section in the Taxi Meter Integration Guide for full details.

---
Source: https://docs.cabfare.com/api/installation-and-setup