Getting Started

View as Markdown

Step 1 — Request Credentials

All API calls to CabFare Connect require authentication using an X-API-KEY and X-API-SECRET. These credentials are issued by CabFare and are unique to your integration.

To request your credentials contact the CabFare integration team at support@cabfare.com.

Separate credentials are issued for the sandbox environment and the production environment. Do not use sandbox credentials against the production API or vice versa.

Step 2 — Identify Your Integration Persona

Determine which role applies to your system:

• Taxi Meter / Dispatch Partner — you govern shifts, calculate fares, and manage Subsidy Scheme member validation
• Payment Terminal Partner — you initiate the device link, read Subsidy Cards, and process card payments

Your persona determines which endpoints you must call and which endpoints you must host. Refer to the relevant Integration Guide in the Development section for a persona-specific checklist.

Step 3 — Access the Sandbox

Point your development environment to the sandbox base URL for your location. Sandbox environments are provided per location. Refer to the relevant location section for sandbox details and test data.

Step 4 — Review the Workflows

Before implementing individual endpoints, read through the Workflows section to understand the end-to-end sequence of events across a full driver shift. This will help you understand the context of each endpoint before you implement it.

Step 5 — Implement and Test

Use the API Reference sections to implement your endpoints. Use the sandbox test data provided in your location section to validate your implementation against defined scenarios before requesting production credentials.

Support

If you encounter any issues during your integration contact the CabFare technical support team at support@cabfare.com.