Installation & Setup
7 min
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 the driver logs in on the taxi meter — post /meter/driver/login with taximeterid , driverid , vehicleplate the driver logs in on the payment terminal — post /terminal/driver/login with terminalid , driverid the payment terminal sends a link request — post /terminal/link/request cabfare connect forwards the link request to the taxi meter 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