Welcome Guest! Login? Checkout

This is the documentation for both WP Taxi Me and WP Taxi Me Premium plugin.

Document Index

  1. Plugin Prerequisites
  2. Installation
  3. Setting Up
  4. Debug Mode
  5. Using Mapbox for Geolocation
  6. Premium – Installation
  7. Premium – Affiliate Link & Colour Setup
  8. Premium – Set Up Estimate Pricing
  9. Premium – Define Custom Locations
  10. Premium – Coordinate Based Locations
  11. Premium – Old Lyft Integration
  12. Premium – New Lyft Integration
  13. Further Support
  14. Bug Fixes

Plugin Prerequisites

There are a couple of prerequisites for this plugin.

The first plugin prerequisite is to make sure that your city is covered in the Uber’s Supported Cities List, as at the moment Uber currently works only in those cities.

The second prerequisite is if you are using the premium version of the plugin, then you must use a secure connection (SSL certificate) for your site (HTTPS). This will require some setting up on various hosts, but we recommend using Namecheap should you need an SSL certificate.

Installation

To install WP Taxi Me Free:-

  1. Upload the plugin to the /wp-content/plugins/ directory or use the Add New feature
  2. Activate the plugin through the ‘Plugins’ menu in WordPress
  3. Fill in your business or location details in the Settings > WP Taxi Me menu.
  4. To add the button to the post or page, please use the [taxi-me] shortcode within the post content.

Setting Up

wp-taxime-settings

The settings page is located under WP Taxi Me menu. It will allow you to set an address for the destination for the Taxi Me button. Simply fill in the address. Other options are the following:-

  • Include Register for Uber Button – This will allow you to add a link beneath the button to register for Uber. v2.1 allows showing the button on Mobile or Desktop.
  • Link To Us (optional, but appreciated) – If you like this plugin, please click this button so you can link to us.

Debug Mode

In version 1.1 of WP Taxi Me, a Debug Mode was introduced. If ticked, the Uber taxi buttons are displayed even when the user isn’t on a mobile. Use this option to test the button is working.

Using Mapbox for Geolocation

From WP Taxi Me 2.3, to geolocate your destination, you will need some form of API. Previously this was Google Maps, but we’ve switched to Mapbox. When you have completed signup, you are taken to your account after singing in. You will have a default public token, click the “copy” box next to it. This will copy the Default public token to your clipboard.

Return to WP Taxi Me > Settings, and paste the Default Public token within WP Taxi Me.

Premium – Installation

After buying WP Taxi Me Premium, you will receive a licence key and a link to download the latest version. Upload the plugin via the Add New > Upload New Plugin method, and when done, a WP Taxi Me Premium Licence menu will appear in the Plugin menu.

wp-taxi-me-premium-licence

Add your Licence Key to the box and press “Save Changes”. An “Activate Licence” box will appear. Click that box to activate your licence.

Premium – Affiliate Link & Colour Setup

With the premium version, you can change the colour of the button. There are four options:-

  • Button Text Colour – The colour of the text on the button.
  • Button Background Colour – The background colour of the button.
  • Button Text Colour (Hover) – The button text colour when your mouse is over the button.
  • Button Background Colour (Hover) – The button colour when your mouse is over the button.

Another option is the Your Uber Affiliate Link. This allows you to change the affiliate link of the “Register for Uber” button.

Premium – Set Up Estimate Time/Pricing

As stated above, you need a secure site to make the Estimated Time/Pricing feature works. If you have a secure site, head to https://developer.uber.com/ and click on “Manage Apps” to set up your application.

wp-taxi-me-premium-manage-apps

Here’s what should be in each box:-

  • Name  Your site’s name
  • Description – The description of your app.
  • Redirect URL – Your site’s secure URL (without trailing slash).
  • Origin URI – Your site’s secure URL (without trailing slash).
  • Privacy Policy URL – This is to a page on your site which details your privacy policy.

Leave every other box empty, agree to their terms of service, and click “Save”. You will then be given a Server Token.

wp-taxi-me-estimated-settings

Return to WP Taxi Me Premium, and then under Estimated Price/Time Settings add the following:-

  • Server Token – The server token taken from your Uber App.
  • Show Estimates – Allow you to add the estimated time, price or none at all.

Premium – Define Custom Locations

From version 1.4 of WP Taxi Me Premium you can now set up custom locations. If you have more than one location for your business, you can now add them and list them easily using the extended shortcode.

By default in the free version of WP Taxi Me, the [taxi-me] shortcode doesn’t come with any arguments, but in the premium version, you have the following attributes:-

  • name – the business name
  • address1 – the first line of the address
  • address2 – the second line of the address
  • state – the state/county of the address
  • zip – the post/zip code

If not added, the default address is used instead.

So to get a taxi to Afflecks Palace in Manchester, use this shortcode:-

[taxi-me name="Afflecks Palace" address1="52 Church St" address2="" state="Manchester" zip="M4 1PW"]

Premium – Coordinate Locations

From version 2.0 of WP Taxi Me Premium you can now set up locations by latitude and longitude. This is useful if your address is incorrect.

The [taxi-me-coords] shortcode comes with 3 options:-

  • name – the business name
  • lat – the latitude of the location
  • lng – the longitude of the location

If not added, the default address is used instead.

So to get a taxi to Manchester Picadilly Station with the title “Bunny Rabbits” in Manchester, use this shortcode:-

[taxi-me-coords name="Bunny Rabbits" lat="53.477403" long="-2.230932"]

Premium – Old Lyft Integration

From version 2.1 WP Taxi Me Premium also integrates with Lyft, an alternative Taxi booking system. So if you want to give a choice on how the user comes to your location, you can do.

To set up your default settings, go to the WP Taxi Me settings page and you can choose the colour or the size of the Lyft button.

Once done, add [lyft-button]  to the site. The [lyft-button] shortcode comes with 7 options:-

  • name – the business name
  • address1 – the first line of the address
  • address2 – the second line of the address
  • state – the state/county of the address
  • zip – the post/zip code
  • colour – the colour of the button, allowed values are “multicolor”, “hot-pink”, “mulberry-light”, “mulberry-dark”.
  • size – the size of the button, allowed values are “small”, “medium”, “large”.

So to get a lyft to Afflecks Palace in Manchester, with a large, pink button, use this shortcode:-

[lyft-button name="Afflecks Palace" address1="52 Church St" address2="" state="Manchester" zip="M4 1PW" colour="hot-pink" size="medium"]

New Lyft Integration

From WP Taxi Me 2.4 you can now use the new Lyft Integration. This will allow you to add your Lyft Affiliate Code to buttons, increasing your revenue.

This does require the button setting up as an app, to do this, follow the guide below.

  1. Sign up for a Lyft Developer account.
  2. Click “Create New App”
  3. Give you app a name, give a description and a contact email. You don’t need to worry about anything else. Finally – agree to the API Terms of Service & Brand Guidelines.
  4. On your app’s screen copy the Client ID and Client Token to a safe place.
  5. Return to WordPress and in the Dashboard go to Settings > WP Taxi Me. Under “Advanced Settings” paste the Client ID and Client Token in the relevant boxes.

The new Lyft integration has (from version 2.4) has two new attributes.

  • lat – The latitude of the location
  • lng – The longitude of the location

So to get a lyft to Times Square in New York, with a large, pink button, use this shortcode:-

[lyft-button name="Times Square" lat="40.759010" lng="-73.984474" colour="hot-pink" size="medium"]

Further Support

Support can be provided in one of two ways:-

Bug Fixes

If you spot a bug, please submit a bug on Github.