How do I authenticate with the Customer API and send a job via HTTPS?

How do I authenticate with the Customer API and send a job via HTTPS?

The Customer API is available to all users by default and can be used to submit bookings or check live statuses. You do not need fleet approval or an API key to use this API.

Authentication

To authenticate with the Customer API, use the same credentials as your customer account:

  • Username: Usually the mobile number used to log in (e.g. 447900123456)
  • Password: The 4-12 digit PIN linked to the account

These credentials should be passed as parameters in your HTTPS request.

API Endpoint

All requests to the Customer API are made to the following base URL:

https://cp.gazoop.com/public_api/live.json

You can also replace live with the name of a specific command to simplify the request. For example:

https://cp.gazoop.com/public_api/airports.json

Data Format

All data is sent via HTTPS POST and responses are returned as JSON.

Example Use Case

To submit a new booking, you would send a request to live.json with the following parameters (among others):

  • username - your customer login
  • password - your PIN code
  • command - for example, create_booking
  • ...plus booking-specific data like pickup location, dropoff location, and time

Always test your payloads in a development environment before using them in production.

For a full list of available commands and parameters, visit the Customer API documentation at docs.gazoop.com.