This guide will explain how to integrate EasyTaxiOffice dispatch software with Transferz.com. This integration enables the import of bookings from Transferz.com to the EasyTaxiOffice system and its complete management from the EasyTaxiOffice system.

Setup

  1. Go to Settings > Integration > Transferz tab.
  2. Activate production mode and generate your API key using the production credentials provided by Transferz; sandbox testing is not required.
  3. Set up API key.
    • In the API key field, click the Generate button.
    • In the popup, enter your Transferz.com email and password. Read step 2 to learn what login details you should use.
    • Click the Login and generate button.
    • The API key will be inserted into the API key field.
  4. Assign vehicle types.
    • Select the appropriate vehicle type from the dropdown list for each Transferz.com vehicle category.
  5. Adjust other options to your needs.
    • Select the When the booking status is cancelled, change the payment status to cancelled checkbox if you want the payment status to be changed to cancelled when the booking is cancelled.
    • Select the When the booking status is cancelled, set driver commission to zero checkbox if you want the driver commission to be set to zero when the booking is cancelled.
    • Select the Mark payment as paid checkbox if you want the payment to be marked as paid when the booking is imported.
  6. Transferz driver options.
    • Select the Enable assign driver checkbox if you want to be able to assign drivers to Transferz.com bookings.
    • Select the Notify driver by SMS checkbox if you want to notify the driver of the booking by SMS.
    • Select the Send the driver's name checkbox if you want to send the driver's name to the customer.
    • Select the Send the driver's phone number checkbox if you want to send the driver's phone number to the customer.
    • Select the Send the driver's last known position checkbox if you want to send the driver's last known position to the customer.
  7. Activate the integration.
    • Select the Activate this service checkbox to enable the integration and save settings.
  8. Import previous bookings.
    • Click this button to import bookings from Transferz within a specified time range (starting from the import moment). This saves time by eliminating manual entry of past bookings. Use this feature only once during initial setup.

Usage

  1. Go to Bookings > Transferz Offers tab.
    • This tab will display all available booking offers from Transferz.com.
    • You can either accept or reject the job.
    • Any booking changes, e.g., journey date change, will also appear as an offer that can be accepted or rejected.
  2. Once the booking is accepted, it will automatically appear in the Bookings tab.
    • From here, you can further manage the booking, such as assigning a driver and completing the job.
  3. Sync booking changes.
    • Click the Sync source > Transferz button in the Bookings tab.
    • This will download the latest changes to bookings, e.g., customer details, journey date changes, booking cancellations.

Additional Notes & Information

To make the integration work correctly, a few things need to be taken into account.
  1. API Key requirement.
    • Transferz.com API key is required; obtain it by following the setup process described above.
  2. Vehicle mapping.
    • Map Transferz.com vehicle categories to EasyTaxiOffice vehicle types. This is important for ensuring that bookings are assigned to the correct vehicles.
  3. Driver phone number format.
    • The driver's phone number must be correct to deliver SMS notifications effectively, including the country code (+XX).
    • Ensure the driver's accurate phone number is provided to avoid missed notifications and communication disruptions.
  4. Assigning a driver.
    • A driver needs to be assigned before the booking status is set to On route.
    • This ensures that the driver is ready and informed about the booking before starting the journey.
    • To avoid problems with assigning a driver, make sure the mobile phone number is included in the driver's profile.
  5. Completing booking on schedule.
    • Do not mark a booking as Completed before the scheduled pickup date.
    • Completing a booking prematurely can cause discrepancies and errors in the system.
  6. Sequential booking process.
    • Follow a specific sequence for the booking process:
      • Accept or reject the offer.
      • Once accepted, assign a driver.
      • Activate each status in order: On route, Arrived, On board, or No show.
      • Only mark the booking as Completed after the journey is finished.
  7. Driver app usage.
    • Use the driver app to provide driver coordinates for driver events.
    • The driver app is the primary source for real-time location data and accurate journey progress information.

Webhook Configuration

This section explains how to correctly configure the webhook settings required for the Transferz integration. Follow these steps to ensure smooth data flow between EasyTaxiOffice and Transferz.

1. Webhook URL

The Webhook URL is the endpoint that Transferz will use to send booking updates and status changes back to your EasyTaxiOffice system.

  • Copy the Webhook URL displayed in your EasyTaxiOffice Integration settings.

  • The field is located under Settings → Integration → Transferz → Webhook.

  • It looks similar to: https://yourdomain.com/api/v1/transferz/webhooks/xyz123456789.

2. Provide Webhook URL to Transferz Support

To activate the integration, you must send this Webhook URL to the Transferz support team.

  • Open a support ticket with Transferz.

  • Include the copied Webhook URL.

  • Request them to configure this URL on their side for your account.

This step is required so that Transferz can push updates (e.g., status changes, cancellations) directly into your EasyTaxiOffice system.

3. Webhook Secret

The Webhook Secret is a security token used to verify the authenticity of incoming webhook requests from Transferz.

Important:
The Webhook Secret is generated and provided by the Transferz team, not by EasyTaxiOffice.

  • After sending your Webhook URL, Transferz will supply you with the Webhook Secret.

  • Once received, enter this secret into the Webhook Secret field in your EasyTaxiOffice Integration settings.

  • Do not share it publicly or with third parties—only Transferz should know this token.

4. Sandbox Mode

If you are testing:

  • Enable Sandbox Mode.

  • Provide Transferz with the sandbox Webhook URL as seen in your settings.

When you are ready for real bookings:

  • Disable Sandbox Mode to switch to the live environment.

5. Data Synchronisation & Status Management

Webhook updates received from Transferz will automatically trigger data synchronisation and booking status updates. Make sure the corresponding settings in your Integration panel reflect how you wish bookings to behave.

Troubleshooting

If you encounter issues, contact the EasyTaxiOffice or Transferz.com support team.