Booking plugin document - Make WordPress website easy and fast

Booking plugin for WordPress Document

You can ask the Questions on the Support Forum for pre-sale preparation of Booking plugin for WordPress. For already purchased Customers we Offer Tickets Service support for resolve technical problems and exploration issues.

QUICK START GUIDE

So, Booking Plugin will help you easy to create a booking platform for Trip and Delivery into WordPress website, Mobile apps or blog. The booking platform provides a lot of booking widgets, order forms, order sent and payment forms.

Plugin Installation

To install Booking Plugin, download it from the https://3bit.app website after purchase. Once it has been downloaded unzip the file and upload the 3bit.zip file to your WordPress website either through the user interface or by unzipping it and using an FTP. Warning! Please ensure WooCommerce is installed before you using Booking Plugin Settings for WooCommerce synchronisation! It will not work without it. If you want to update Booking Plugin with any of the future updates that will be published you will Export data to restore file in the Plugin Settings. Then delete the old version of the Plugin from your website (this will delete your Plugin data). After this, upload the new version of the Plugin to your website and activate it. Import data in the Plugin Settings from file for restore. Use Plugin Update key for automatic update the Plugin from the Update server.

Database Codepage

Ensure you have selected the correct codepage for the backend database. To do this go to Hosting administration console, such as cPanel. Start phpMyAdmin tool and set UTF-8 codepage for the database schema. If You will work with not only latin languages. If you use UTF-8 for the database schema follow these steps: (Recommendation for database Collation with UTF-8 codepage):

Step 1 – Before WordPress install to Your database backend, set the Database Collation to UTF-8 (such as: utf8_general_ci or utf8mb4_unicode_ci).
Step 2 – Before Booking Plugin install to WordPress CMS set the Server Connection Collation to UTF-8 (such as: utf8_general_ci or utf8mb4_unicode_ci).

Plugin Timezone

Ensure you have selected the correct time zone you are in. To do this go to WordPress administration console Plugin Home > AdminPanel > Users&Features > Settings > Set the time_zone value as UTC offset (such as, +02:00).

Displaying the Booking Form

To display the Booking Plugin booking, payment and widget forms, use the shortcodeCallCustomForm see details in the article for Shortcodes.

PLUGIN SHORTCODE

Shortcode of Booking Plugin for WordPress is CallCustomForm, using with a lot of parameters

Example: [ CallCustomFormpage_name=cabinet.html tab_number=2 username=admin password=admin map_provider=google language=ENGLISH]<br>

Parameters of the Shortcode

page_name – name of Custom form (always required);

tab_number – number of tab on Cabinet form;

order_id – number id of order on Cabinet form;

username – default Login credentials;

password - default Login credentials;

map_provider – plugin map provider (required values : “google”, “yandex”, “osm”, “here”, “mapbox”, “mapquest”. Warning! Maps Directions, Geocoding, Places using by default Google Maps API provider, for map preview using one of selected provider);

language – use Language on form (one of values;
/admin/json/messages.json in field “name” of messages array, such as "name" : "ENGLISH", english by default);

callback (or order_callback for Booking forms) – Callback page href for Login, Register or Booking forms (call as location.href in javascript);

widget_callback (or callback) – Widget form Callback page href for call form page after widget on main page (call as location.href in javascript);

input_data – input data (Id numbers of products) for use in Booking form or Widget form;

Forms
Trip Booking Form	[ CallCustomForm page_name=forms/bookings/trip_booking.html]
Trip Fast Booking Form	[ CallCustomForm page_name=forms/bookings/trip_fast_booking.html]
Tour Booking Form	[ CallCustomForm page_name=forms/bookings/tour_booking.html]
Trip Airport Booking Form	[ CallCustomForm page_name=forms/bookings/trip_airport_booking.html]
Trip Rental Booking Form	[ CallCustomForm page_name=forms/bookings/trip_retal_booking.html]
Delivery Booking Form	[ CallCustomForm page_name=forms/bookings/delivery_booking.html]
Product Booking Form	[ CallCustomForm page_name=forms/bookings/product_booking.html]
Service Booking Form	[ CallCustomForm page_name=forms/bookings/service_booking.html]
Order Sent Form	[ CallCustomForm page_name=forms/bookings/order_sent.html]

Widgets
Trip Widget	[ CallCustomForm page_name=forms/widgets/trip_widget.html callback=link to page]
Tour Widget	[ CallCustomForm page_name=forms/widgets/tour_widget.html callback=link to page]
Tabs Widget	[ CallCustomForm page_name=forms/widgets/tabs_widget.html widget_callback=link tab 1 to page 1 order_callback= link tab 2 to page 2]
Delivery Widget	[ CallCustomForm page_name=forms/widgets/delivery_widget.html callback=link to page]
Product Widget	[ CallCustomForm page_name=forms/widgets/product_widget.html callback=link to page]
Trip Booking Widget	[ CallCustomForm page_name=forms/widgets/trip_booking_widget.html callback=link to page]

Payment
Order Payment Form	[ CallCustomForm page_name=forms/payments/order_payment.html]
Wallet Payment Form	[ CallCustomForm page_name=forms/payments/wallet_payment.html]

Cabinet
Login Form	[ CallCustomForm page_name=login.html]
Register Form	[ CallCustomForm page_name=register.html]
Cabinet Form	[ CallCustomForm page_name=cabinet.html]
Map Form	[ CallCustomForm page_name=map.html map_provider=mapbox]
Last Order	[ CallCustomForm page_name=cabinet.html order_id=-1]
Order By Id	[ CallCustomForm page_name=cabinet.html order_id=orderId number value]
Cabinet Orders	[ CallCustomForm page_name=cabinet.html tab_number=0]
Cabinet Reports	[ CallCustomForm page_name=cabinet.html tab_number=1]
Cabinet Messages	[ CallCustomForm page_name=cabinet.html tab_number=2]
Cabinet Profile	[ CallCustomForm page_name=cabinet.html tab_number=3]
Cabinet Payments	[ CallCustomForm page_name=cabinet.html tab_number=4]

GOOGLE API KEY ISSUES

If you are seeing the error message when you try to book an order (“Book now” or “Send an Order” in the Plugin booking forms. “Find” locations in the WordPress administration console Plugin Home > AdminPanel) then there is an issue with your Google Maps API key. Warning! API keys with referer restrictions cannot be used with this API. This means you have either not enabled the services required for Booking Plugin to work or there are some restriction on the API key. Please log into your Google Console and ensure the following services are activated:

Google Maps JavaScript API
Google Maps Places API
Google Maps Geocoding API
Google Maps Directions API

Also ensure the Google Maps API key can be used by the website you are hosting Booking Plugin on. If you are still getting the same error after the above steps try disable the HTTP restrictions completely and check again. If it works after this there are some issue with the HTTP restrictions you have placed on the Google Maps API key. Read this guide for more information on how to configure Google Maps API key settings (Using API Keys read this guide).

AUTOMATIC INSTALLATION

To add Booking Plugin using the built-in plugin installer:

Step 1 - Go to Plugins > Add New in WordPress administration console.
Step 2 - Click Upload Plugin on top of the page.
Step 3 - Click Choose File and select 3bit.zip from your computer, the one you downloaded from https://3bit.app.
Step 4 - Click Install Now to install Booking Plugin.
Step 5 - After installation is complete, click Activate Plugin to activate Booking Plugin.

MANUAL INSTALLATION

The manual installation of Booking Plugin requires FTP familiarity.

Step 1 - Connect to your web server with your FTP program.
Step 2 - Go where your WordPress files are, to the folder wp-content/plugins.
Step 3 - Upload the folder 3bit from the zip file you downloaded.
Step 4 - Go to Plugins screen, in WordPress administration console, and find the newly uploaded Booking Plugin in the list.
Step 5 - Click Activate to activate it.

THE SERVER CRASHED

When installing or updating the Plugin, due to the large number of processes that run only when the Plugin is installed, it is possible that your server will crash. One solution is to increase the memory allocated to PHP. WordPress provides instructions on how to do that.

INSTALLATION FAILED

If the Booking Plugin did not install properly, or you have problems with WordPress administration console after installation, please write us to the Support and we will debug the problem for you. The problem is always caused by incompatibility with another plugin, theme or the server is not configured correctly.

GET PLUGIN UPDATE KEY

Once you ordered Booking Plugin from https://3bit.app, you will receive an email with your order which contains the Plugin Update key. You can also get your Plugin Update key from your account on https://3bit.app. There, you will have the list of all your keys.

ACTIVATE YOUR PLUGIN UPDATE KEY

To activate your Plugin Update key follow the steps:

Step 1 - Sign into your WordPress administrative console.
Step 2 - Go to Plugin Home> Settings page.
Step 3 - Select Plugin Update key input field.
Step 4 - Enter the Update key and click on “Save” button at the bottom.

UPDATE YOUR PLUGIN

Before update the Booking Plugin to a new version automatic in WordPress administrative console Plugins > 3bit > Update, Export Plugin data (Plugin Home > Settings > Export) to restore SQL file (backup dump) and save style CSS file /admin/css/style.css (if you have changed it).

HOW TO USE CUSTOM CSS STYLE IN PLUGIN

You can use private CSS styles for the Plugin booking, payment and widget forms by changing file /admin/css/style.css for HTML tags or classes. The Booking Plugin using Bootstrap3 framework (Bootstrap4 in future version 1.2). You can specially defined other private CSS style file in WordPress administration console Plugin Home > AdminPanel > Users&Features > Settings > Set the style_script value as filepath to Your private CSS file.

IMPORT AND EXPORT DATA

You can Import (Plugin Home > Settings > Import) old data or backup dump to the Booking Plugin (this is especially important after using website copying utilities, such as Duplicator plugin). Before using website copying utilities, You can do Export data in Settings page of the Booking plugin. Export saving Your data of the Booking plugin in SQL format. You can use SQL file to restore Your data by phpMyAdmin tool of Your hosting provider (Import/Export tools for SQL dump). Normal case to restore Your data is Import in Settings page of the Booking Plugin (Plugin Home > Settings > Export). Attention! When You restored Your website by thrid-part plugin, highly recommended restore Plugin's procedures and functions by Restore Plugin routines After WordPress restore (set the switch to ON and save the Settings).

IMPORT AND EXPORT DATA

USING PRIVATE API PARAMETERS

You can use (Plugin Home > Settings > Plugin API Parameters) Private Plugin API parameters (Username, Password) for the Booking Plugin administrative tools (Plugin API url, Plugin API key must be empty for Your Local database backend). Go to Cabinet administrative page and can change password credentials on the User profile tab (default is 'admin'). For create other one administrative credentials Go to Admin Panel page and open Admin Panel > Users & Features > User and click on '+' button for creation. Private API parameters using for the Booking Plugin administrative tools: Admin Panel, Cabinet, Calendar, Map, Order (fast order creation), Transport(fast transport booking) pages.

PLUGIN FORMS PARAMETERS

You can use (Plugin Home > Settings > Plugin Forms) Definitions and Limitation parameters for Plugin Forms: Distance Measurement, Minimum Distance, Maximum Distance, Date Format, Time Format, Map Zoom, Country, Order Tax, Acceptance Regions and Theme colors. For using Your private messages for Minimum Distance, Maximum Distance, Acceptance Regions and Order Available Ontime mismatch in the Plugin Forms, input Your strings to Messages (Plugin Home > Settings > Messages). More parameters and messages available Plugin Home > Admin Panel > Users & Features > Settings.

HOW TO USE PLUGIN EMAIL NOTIFICATION

You can use (Plugin Home > Mailings) Mailings as Email notifications in the Booking Plugin for events: Password Recovery (for mobile app), New Order, Order Status changed, Payment Confirmation. Email notification in the Booking Plugin can be sent to Event owner (Order creator, Password recovery creator) and to one Administrator by email address. Warning! Very important use recommended by Your hosting provider SMTP settings. Specify parameters for using: SMTP hostname (use prefix ssl:// or tls:// for security purposes, such as ssl://smtphostname.com:465), SMTP username, SMTP password. You can define text of notify messages for event and set up the events You want use for notification.

HOW TO USE PLUGIN PAYMENT GATEWAYS

You can use (Plugin Home > Gateways) Payment gateways in the Booking Plugin: PayPal, Stripe, LiqPay, Braintree. You can use Cognalys provider for phone number verify (for mobile app). PayPal and LiqPay require callback functions for payment result backend notify. Specify callback's URL for LiqPay and create URL with PayPal Webhook Id on PayPal administration console for developers (https://developer.paypal.com). Specify administration credentials for work with callback notify: Administrator username for callback function. Use type of payment 'Sanbox' for gateway debug, and 'Production' for work in payment mode. For creation gateways keys and other parametes use next links (for create account and for create keys and debug use developer's link) and follow the instructions on the website:

PayPal https://www.paypal.com for developers https://developer.paypal.com
Stripe https://stripe.com for developers https://stripe.dev
LiqPay https://www.liqpay.ua
Braintree https://www.braintreepayments.com for developers https://developers.braintreepayments.com

HOW TO USE PLUGIN TAX FOR CUSTOMERS

You can use (Plugin Home > Gateways) Tax for customers in the Booking Plugin: Client, Driver. Tax for customers is Your side fee for using Your system for Clients and Drivers. You can use Tax for customers for: every Order, per Month (in value or percent from Order price). Sum of funds will be decrease Prepaid amount of User when Orderer, per Month. Customer can increase own private Prepaid amount (Account Balance) in the Payments tab of the Cabinet page.

PLUGIN CABINET PAGE

You can use (Plugin Home > Cabinet) Cabinet page for administrative purpose and control with the tabs Sent orders, Reports, Messages, User profile and Payments : • Bookings in descending order (Complete the Order set Driver for Order, Reset a Status for Order Status, Payment order, Cancel Order) • Tracking of Clients and Drivers • Messages from Customers to Administrator • Private User profile • Private Payments to Prepaid amount (Account Balance)

PLUGIN CALENDAR PAGE

You can use (Plugin Home > Calendar) Calendar for preview and control incoming orders form customers group by days of month. You can short information preview for every Order and open Cabinet page for selected order (click on button “Open an Order”). Calendar navigation use control buttons for Day, Week, Month and Today smart navigation.

PLUGIN MAP PAGE

You can use (Plugin Home > Map) Map for real-time Orders and Transports preview (For watching set the switch-button “Watching” in ON position, Attention! GPS devices in Transports installed), control every Transport by smart control buttons under Transport's name for Location, Watch, NoWatch actions (for selected Transport).

PLUGIN ADMIN PANEL PAGE

You can use (Plugin Home > Admin Panel) Admin Panel for Plugin's data manipulation and administrative control. Data separated to 3 groups: Users and Features, Types and Attr, Trade and Services.Users and Features provides data audit, system settings, users, transports and other base objects information for the system:

Audit system events audit log
Settings system settings for bookings and other options
Project system information of remote of local installed database backend
Dashboard summary information for administrator or for selected customer
User list of customers profiles with Prepaid amount (Account Balance)
Transport list of transports with attached Sensor (GPS device)
Transport type part list of transports that have a type
Sensor list of GPS devices
Document list of customers documents that have been sent to system
Discount list of features that increase or decrease a price of Service or Product by Code
Tax list of features that increase a price of Service or Product in Order and list of customers fee (for clients or drivers) for using system.
Messages list of administrative messages, using for technical or important issues
User review, Product review, Transport review customers reviews of User,Product,Transport
Track tracking points list of GPS devices
Sensor circle list of temporary united customers Sensors for visibility of their Track one to other, when Order not completed
Sensor place list of important locations of customers Sensors

Types and Attr provides types and attributes parameters of the base objects of the system:

Attr attributes parameters names list
Attr part list of translations for the objects of the system
Color list of colors
Currency list of currencies with only one active (main)
Language list of languages that used for translations
Delivery type list of types for delivery Products
Track type list of types for Track
Order place list of places that used in Booking Forms and Widgets (depends of type) for pickup and dropoff Locations
Order status list of status. Warning! Don't remove any of status records, all status has been reserved for Booking Forms and Widgets, Mobile applications.
Pickup status list of pickup status for Shared Trips
Product param list of add-on parameters or Services for Products
Product type list of calculate formulas of products, identifier by Value
Transport type list of types for Transport

Trade and Services provides trade operations and products/services information for the system: • Stock provides Products in Stores with count information. Attention! For activate Product in Booking Forms and Widgets set Product count more then 0. • Stock invoice provides information about receipts at Store • Stock invoice part provides details information about Products receipt at Store • Store provides information about points of Service or Products booking • Store part provides information about Locations of Store Points. Attention! Locations of Store points using in Booking Forms and Widgets for delivery Services. • Order provides information about customers bookings • Scheduled Order provides information about Accepted Orders for selected date • Order product provides information about Products in Orders • Manufacture provides information about Products owner or maker • Product provides products/services for customers booking • Product param part add-on parameters or services attached to Products • Product type part calculate formulas attached to Products • Purchase list of purchased Orders • Payment credit card paid list • Prepaid card list of manufactured special cards with a recharge code for customers Prepaid amount (Account Balance). Customer can replenish private own account in Cabinet page.

PLUGIN ADMIN PANEL PAGE

Audit system events audit log
Settings system settings for bookings and other options
Project system information of remote of local installed database backend
Dashboard summary information for administrator or for selected customer
User list of customers profiles with Prepaid amount (Account Balance)
Transport list of transports with attached Sensor (GPS device)
Transport type part list of transports that have a type
Sensor list of GPS devices
Document list of customers documents that have been sent to system
Discount list of features that increase or decrease a price of Service or Product by Code
Tax list of features that increase a price of Service or Product in Order and list of customers fee (for clients or drivers) for using system.
Messages list of administrative messages, using for technical or important issues
User review, Product review, Transport review customers reviews of User,Product,Transport
Track tracking points list of GPS devices
Sensor circle list of temporary united customers Sensors for visibility of their Track one to other, when Order not completed
Sensor place list of important locations of customers Sensors

Types and Attr provides types and attributes parameters of the base objects of the system:

Attr attributes parameters names list
Attr part list of translations for the objects of the system
Color list of colors
Currency list of currencies with only one active (main)
Language list of languages that used for translations
Delivery type list of types for delivery Products
Track type list of types for Track
Order place list of places that used in Booking Forms and Widgets (depends of type) for pickup and dropoff Locations
Order status list of status. Warning! Don't remove any of status records, all status has been reserved for Booking Forms and Widgets, Mobile applications.
Pickup status list of pickup status for Shared Trips
Product param list of add-on parameters or Services for Products
Product type list of calculate formulas of products, identifier by Value
Transport type list of types for Transport

HOW TO USE PLUGIN WITH WOOCOMMERCE

If you want to integrate the Booking Plugin with WooCommerce follow these steps:

Step 1 – Go to WordPress administration console Plugin Home > Settings and Set option WooCommerce products synchronization.
Step 2 – Go to WordPress administration console Plugin Home > Settings and Set option WooCommerce orders synchronization.
Step 3 – Save WooCommerce synchronization options for Settings of the Booking Plugin.

Warning! After saving WooCommerce synchronisation options Triggers for the Booking Plugin tables and for WooCommerce tables will be created. The Booking Plugin Triggers automatic copy data (from Booking Plugin to WooCommerce) when products, orders objects created. After restore database or duplicated data from other server need to restore options for WooCommerce synchronization.

PLUGIN DATA SYNCHRONIZATION WITH WOOCOMMERCE

Plugin data Synchronization with WooCommerce in automatic mode by Triggers for the Booking Plugin and WooCommerce data tables. When You created products or orders in the Booking Plugin platform similar WooCommerce objects created. Products can be edited in the Booking Plugin and in WooCommerce with automatic data copying by Triggers. Warning! Pictures don't copy automatic.

PLUGIN USERS SYNCHRONIZATION WITH WORDPRESS

Plugin users Synchronization with WordPress in automatic mode by Triggers for the Booking Plugin and WordPress data tables. When You created users in the Booking Plugin platform similar WooCommerce objects created. Users can be edited in the Booking Plugin and in WooCommerce with automatic data copying by Triggers. Warning! Pictures don't copy automatic. All Users will be created with empty password! Change password after new user was created. If you want to integrate the Booking Plugin users with WordPress follow these steps:

Step 1 – Go to WordPress administration console Plugin Home > Settings and Set option WordPress users synchronisation.
Step 2 – Save WordPress synchronisation option for Settings of the Booking Plugin.

PLUGIN FEATURES

Languages	WordPress Synchronization and Plugin Restore	WooCommerce Synchronization	Import and Export Plugin Data
Distance Measurement	Datetime Format	Country and Map Zoom	Order Tax
Theme Color	Acceptance Regions	Custom Messages	Maximum Order Hourly
Maximum Passengers Count	Order Price per Minute	Return Price Ratio	Surge Price Ratio
Surge Price Time Range	Order Time Schedule	Order Available Ontime	Distance Included to Tariff
Current Timezone	Convert Plugin Data to Pdf	Audit log	Currency
Discount	Product Type	Order Place	Store Place
Mailings	Password Recovery	Order Status Notification	Payment Confirmation Notification
Payment Gateways	PayPal	Stripe	LiqPay
Braintree	Cognalys Verification	Driver and Client Tax	Route
Calendar	Web API connectivity to the Database backend Android/iOS mobile apps for Clients and Drivers (or Delivery-mans)