Taxi API Usage

Guide to the Taxi API Administrative Application

We hope you find this guide informative, and will relay to the reader key functionality available to you within the TaxiAPI dashboard, once you create your membership.

INITIALLY SETTING UP YOUR ACCOUNT

Once you log in, you will initially be presented with a message to finalize your company’s profile with important information such as business hours, address and website URL. The website URL is an important entry, as this tells the TaxiAPI system where you will be using your services. Most of these entries can be created and updated via the “My Account → My Profile” drop-down menu.

Still others such as options for hours, mileage rate, and other values necessary for proper TaxiAPI functionality can be found using the “Action List → Options & Fees” drop-down menu.

EXPLORING THE MENUS

Most of the interaction with your new TaxiAPI account will come from working with he pages located in the “Action List” menu. Important data entry tasks such as: adding fleet vehicles, drivers, and setting all your booking form options, plus options for showing/hiding available reviews can be found in this menu.

Once these options are set, and assets are added, most of the daily interaction with your dashboard will occur from using the, “Trips & Search” menu item, which we will now explore. This is the default page for the Dashboard and after login, this is the main page. The “Trips & Search” page consists of five key areas:

  • Detailed Search Panel
  • Driver Introduction / Simple Routing Panel
  • System Message Box
  • Action Bar
  • Trips Table

Also at the bottom of every page, there is a “Quick Menu,” a menu that contains navigation links for frequently accessed areas.

EXPLORING TRIPS & SEARCH

Since most of the activities you’ll be engaging in use this pages, let’s go over them now!

1.) DETAILED SEARCH PANEL

Although you can find pretty much any detail you need using the search that’s located near the trip data in the “Trips Table,” that search is less powerful that the, “Detailed Search.” Simply select the field you want to query and enter the value you want to look for.

2.) Driver Introduction / Simple Routing Panel

Every trip that has been booked has been assigned a 36 character, “Trip Id”, and the driver introduction and simple routing panel interact with trip table using this id. When you select a trip by single-clicking a row. you will see the trip id value change in the panel.

 

This panel also contains five important areas:

  • Driver Selection Box
  • Trip ID (Which is read only, and as already mentioned is set via selecting a trip in the trip table)
  • “Include Driver’s Picture Toggle”
  • “Route to This Driver Toggle”
  • Action Button, which submits the action

Currently this is the only way to send a driver introduction to your customer, and takes only a moment. Set your options and use the button to create and send the introduction with or without a picture. If the toggle for, “Route to This Driver” is activated, the Dashboard will also send an email to the driver about the trip, and create a entry in the “Trip Log” table.

3.) SYSTEM MESSAGE BOX

This feature is fairly self-evident and this areas will provide application feedback, and important messages to the user.

 

4.) ACTION BAR

Usage of the action bar is straightforward! Select an action from the drop down menu, and click the “Execute” button to perform that action. Available action include:

  • Get Trip Report
  • Request a Review
  • Resend Confirmation (To the person which booked)
  • Edit Booking
  • Delete Booking

5.) Trips Table

Since one trip is made up of quite a bit of data, each trip has been condensed as much as possible to present the most important details to you at a glance. The, “Trips Table” also contains state data, such as if a review has been requested, or a trip has been routed.

There is a also a powerful search bar that searches all values simultaneously for the tip data you may be looking for.  The “View” buttons in each row allow you to pop up each column’s extended data details, such as “Special Note,” or “Booking Details,” etc.

The table contains standard controls such as pagination, entry values, and you can choose to display certain number of records on the screen to your liking.

That about wraps up demonstrating functions available from this page, and so we’ll move on to the, “Trip Routing” Page. While it’s certainly easy to send an introduction and route at the same time using the “Quick Routing” feature, you can use the, “Trip Routing” page if you have a large volume and like to pre-plan you routing(s) visually using a routing map.

TRIP ROUTING PAGE

This page consists of two areas. The panel on the left has expandable areas which contain pick up and drop-off locations for all booking for that day. It’s important to note that this page only contains trips that have been booked that day, whether or not the trip is to occur that day or some time in the future. The dates of the tip are plain indicated in the panels on the left, and in the drop-down routing box which will be used when actually using the green “Route” button. Select the trip you want to route, the driver that you want to route it to, and click the button. The screen will be refreshed with a success message when routed. The creates an entry in the “Trip Log” table and send an email to the driver indicating they are responsible for that booking, and provide the driver the booking details necessary to complete the trip.

As you explore the trips in the expandable panels, hovering over each trip will set the “Get Direction” from data. When you click the button to get directions, a new page will open with directions provided by Google Maps.

The map itself uses clustering technology, so at a glance you know how many trips are within a certain geographical area.

Let’s now move on to creating your data profiles within the “Action Menu” items.

DRIVERS

This is a basic data entry screen which allows you to create a driver in the system. Only the details such as name, Twitter, Facebook and the details you provide in the “Description” box are sent in the “Driver Introduction” email to the customer. Driver’s license, and phone number are for internal purposes only. Drivers can be edited or added from this screen, and feedback based on what you are doing will be displayed in the “System Message Box” on this page.

FLEET ASSETS

Fleet asset entry is available from this page, and lets you add vehicles, with their license plate information to the system. The options on this page allow you to specify the maximum number of passengers and the vehicle type as well as give them a short name so that you can track them easily. Editing and deletion of fleet assets is also accomplished from this screen. If a particular asset is assigned to a driver, a hyperlink will be available to view that driver on the driver’s page, and set the screen in “Edit Mode.”

OPTIONS & FEES

Taxi API allows many options for you for your booking form. All the options available for the form can be set on this page, and the changes will immediately be reflected on your booking form.

The “Prerequisites” section allows you to turn booking on and off, such as for website maintenance, vacation , etc. When turning, “Off” booking a entry is shown for you to add a custom message in that will be displayed instead of the booking form. This section also contains the most important options such as mileage rate, and hours the booking form will allow bookings. Such as if you will not have any vehicles available to pick anyone up between the hours of 1:00 AM and 5:00 AM, simply set these values as your, “Operating Hours.”

Changes will not be saved until the blue, “Save Prerequisites” button is clicked.

Mileage Producer & Discount Settings

Choose the mileage producer you want. Note: Google maps for routing is always used, no matter which “Mileage producer” is used, and the mileage producer value is used to calculate fares. This option in available because in certain parts of the country, certain producers are more accurate, and you have the ability to se4t this as a personal preference.

Passenger Settings

Choose a extra passenger fee over a certain amount of passengers if so desired.

Booking Restrictions (Date and Time)

There are two ways to restrict the booking calendar shown on the taxi booking form. You can choose to delay booking for a few days, or/and choose to allow trips only certain days of the week. It’s important to know that the booking form will still work, it will simply not allow booking based on your day and date settings here.

Airport Settings

Choose whether or not to charge an airport fee. Note: Airport must be designated within location name, IT: “Airport 1, Airport 2, etc…,” and must be a user-added available location set by using the locations screen. As long as the word, “airport”  appears in the name, TaxiAPI will charge the airport fee if that option has been set here.

Child & Infant Seats

Choose whether or not to charge and infant and/or child seat fee if you company or you provide those to those booking. (most taxi companies do!)

Saving These Options

The button to save any changes is at the bottom of the screen, and this page will warn you if you have unsaved changes and attempt to navigate away without first saving them.

LOCATIONS

This page lets you manage locations. You can edit, add or delete, as well as “pad” the mileage. (up to five miles, which is the maximum allowed by TaxiAPI.) This feature is available to you to ensure that you are getting paid correctly, and for some reason the mileage producer you have selected, such as MapQuest, Bing, or Google is inaccurate due to outdated data, which is VERY infrequent, but for certain areas, such as Military bases, can happen.

REVIEWS

This page allows you to view reviews, and set individual reviews to on or off with a simple toggle. Reviews links are created and sent to the booking party’s email address via the action bar. The “Leave a Review” page is very clean, simple, and easy to use. Reviewers simply select a level of happiness, and if so desired, they can leave a comment. Reviews are displayed immediately upon receipt with the “Reviews Embed Code” available to you from the, “Instructions” link under the “My Account” menu item, or the, “Download API Details” link under the “My Account” menu item.

REPORTING

Available reports can be accessed via the “Reporting” menu item, and you simply select the report you want, and the format you like to receive it in. Depending on your level of service, ad to what reports may be available to you. Taxi API developers can create other reports for you, and you should simply contact us should you need customer report creation.

That’s about it for these detailed instructions, and we recommend to get in there and start familiarizing yourself with the software, and we are an email away if you need help! TaxiAPI was designed to be super user-friendly so we hope you enjoy! Ready to get started and have already signed up? Then log in here.

Thanks, the TaxiAPI Team

Leave a Comment

Pin It on Pinterest

Shares
Share This