Integration with the WordPress Plugin

edoobox can be easily integrated into a WordPress website. Two integration options are available to you. Firstly, you can use the edoobox plugin, which enables seamless integration into your WordPress environment. Secondly, edoobox can be embedded into your WordPress pages via an iFrame.

By integrating edoobox into your WordPress website using the plugin, you benefit from enhanced search engine optimization capabilities. These include URL rewriting for cleaner and more SEO-friendly URLs, as well as optimized meta-data handling. Additionally, the plugin enables direct linking to specific categories and offers, significantly simplifying navigation and user guidance. Another key advantage is the provision of structured data in JSON-LD format, which makes it easier for search engines to accurately capture the content of your offerings and display them effectively in search results.

Integration via the WordPress Plugin 

To install the edoobox plugin on your WordPress website, first navigate to the "Plugins" section in the WordPress dashboard and enter "edoobox" in the search field. Once you've found the plugin, click the "Activate" button A to activate the plugin in your WordPress installation. For more information and a direct link to the edoobox WordPress plugin, visit edoobox WordPress Plugin.

A new menu item, "edoobox, " will now appear in the left-hand navigation bar. Click on it to configure the settings. In the main settings, you must fill in the fields for the Private API Key, Secret API Key, edoobox Account Code, Choose Environment, and Use API V2 .

API Key | Secret API Key

You can find the API key and the corresponding secret API key in your edoobox V2 account under Settings , in the API Access Management section, by clicking "Add Key." Under Permissions, select the predefined WordPress permission.

The Secret API Key is displayed only once when the API Key is created. Store it in a secret and secure location.

edoobox Account Code | edoobox Account Abbreviation

You will find the account code "e " at the top level of the tree structure. In this example, the account code would be " SprachCB."

Choose Environment

edoobox operates with two server environments where your booking system accounts might run: App1 and App2. The App1 environment is hosted by Nine Internet Solutions AG in Zurich and is accessible via the URL https://app1.edoobox.com. In contrast, the App2 environment is hosted by Google Cloud in Zurich and is accessible at https://app2.edoobox.com. To determine which environment your account is based on, simply check your browser's URL while logged in. If you find 'app1' there, you are on the older environment, whereas 'app2' indicates the newer environment.

It is important to understand that the distinction between the App1 and App2 server environments at edoobox is not related to software versions V1 and V2. Regardless of the server environment, users can access both versions of edoobox, but via different URLs, depending on their account's environment.

For accounts running on the App1 server, version V1 of edoobox is accessible via the URL https://app1.edoobox.com. To access version V2, these users must use the URL https://app1.edoobox.com/ed-admin.

Conversely, accounts running on the App2 server can access version V1 at the URL https://app2.edoobox.com and version V2 at https://app2.edoobox.com/ed-admin.

Use API V2

For the edoobox WordPress plugin, which is compatible with both V1 and V2 software versions, API keys can be created and utilized for either version. We generally recommend using API keys for version V2.

If you opt to use API keys for version V2, you must check the Use API V2 setting in the plugin's configuration. This confirms that the plugin should utilize the API keys of the newer version. Conversely, if you wish to use API keys for version V1, you must uncheck this option. This will switch the plugin to use the older API version.

Design Select | Choose Design

Choose whether to adopt the default design or the website's design.

• Option 1: Standard Design loads the default design from the WordPress theme (design must be Bootstrap-based).

• Option 2: Adopt website design, loads the default design for the webpage.

Debugger Code

The new Debugger Code feature in the edoobox WordPress Plugin enables you and our support team to respond more quickly and efficiently to potential issues in your plugin settings. This confidential Debugger Code provides the support team with insight into your settings without compromising sensitive data.

To generate a debug code, go to the edoobox plugin settings in your WordPress dashboard. Just below the main settings, you'll find the " Additional Settings" section. Here, you can generate the debug code by clicking " Generate Code . "

Generate Shortcode

Next, generate the Shortcode by right-clicking on the main directory (Account Abbreviation) or the desired category and selecting «Preview - Share» G.

Open the Embed Plugin   H and click once on the shortcode I to copy it.

Paste the copied shortcode where you want your offers to appear. To do this, use the "Shortcode" block in WordPress. Publish the page— done!  

Shortcode Structure 

The Shortcode consists of several variables. Example: [edbs_panel language=“de“ url=“demo/Deutsch/“ label=“facebook“ tag=“Outdoor“ root=“https://app2.edoobox.com/“ ] 

edbs_panel > edoobox Shortcode Name 

language > defined language, e.g., de 

url > Abbreviation/Category or Course, e.g., demo/Deutsch/ 

label > defined label to specify the source, e.g., Facebook 

tag > Filtering of offerings via the edoobox tagging function 

root > Define the URL that should be called when a user clicks. For example, you might want to display courses on the homepage, but then show the detailed view of the courses on a subpage. Define the target URL here, e.g., https://app2.edoobox.com/ 

anchor > With the tag anchor=true, clicking a button will always link to the edoobox frame. This is ideal for longer pages.

Shortcode Customizations

You can display a specific category or even an individual course, instead of all available courses.

Example code for the entire edoobox account using the 'demo' slug.
[edbs_panel language="de" url="demo" ] 

Example code for displaying the 'Deutsch' category.
[edbs_panel language="de" url="demo/Deutsch" ] 

Example code for displaying course 'Course.ed.168062' and linking directly to the edoobox frame using an anchor.
[edbs_panel language="de" url="demo/Deutsch/Niveau%20A1/Kurs.ed.168062" anchor="true" ] 

Manually add a label or tag to the code.
[edbs_panel language="de" url="demo" label="Startseite" tag="Intensivkurs" ] 

For the calendar, the code can be extended as follows.
[edbs_panel language="de" url="demo/Deutsch/" label="Startseite" tag="Intensivkurs" view="v1" start="2019-08-20" ] 

If you embed a shortcode on the homepage, a root page must be defined to open the offer details upon clicking.
[edbs_panel language="de" url="demo/Deutsch/" label="Startseite" root="www.ihreURL.com/unser_angebot" ] 

Troubleshooting Plugin Issues

The edoobox WordPress plugin is generally stable. However, issues may occasionally arise depending on the specific configurations in your WordPress account or in combination with other plugins.

While our support for plugin issues is generally limited, we are committed to assisting you. To provide efficient assistance, it is crucial that you first gather some information about your plugin and send it to us. We also recommend checking our help section under Solutions for Common Plugin Issues to see if a solution to your problem has already been described. If necessary, you can embed the iFrame as a temporary workaround to offer your customers an alternative booking method.

Initial Steps:

1. Clear Cache:

   • Clear the cache in WordPress under edoobox > Cache.

   • Also clear your browser cache.

2. Disable Cache:

   • Set the setting under edoobox > Cache to 0 hours.

3. PHP Version:

   • Confirm that your server environment is running at least PHP 7.4; otherwise, please update it.

4. WordPress Version:

   • Verify your currently installed WordPress version. Our support covers versions from 5.0 onwards, with current testing up to version 6.5.0.

5. Permalink Settings:

   • Review and confirm your current permalink settings. If necessary, switch to the "Post name" setting for optimal configuration.

If your issue persists, please send us confirmation of the above points, along with the following information, so we can assist you:

1. Basic plugin settings

   • Which API was used for integration? API V1 or API V2?

   • Which environment is affected? app1 or app2?

   • Cache storage time and permalink settings

   • PHP + WordPress version

2. Description of the Issue:

   • Please provide detailed information about your issue and how it can be reproduced.

   • Have you identified any potential solutions yourself?

   • Please provide screenshots or screen recordings of the issue with the console open, and send us the recordings (Link to external guide)

3. URL of the Affected Page:

   • Please provide the exact URLs of the pages where your issue occurs.

4. Browser Information:

   • Please provide your browser name and version.

     • Browser Name: For example, Chrome, Safari, Internet Explorer.

     • Browser Version: You can find this information by searching Google for "find browser version."

5. Shortcodes Used:

   • Open your WordPress site, navigate to edoobox > Page Indexing > Shortcodes, and send us the shortcodes you are using.

6. List of All Active Plugins:

   • Please send us a list of all currently active plugins on your site.

7. Page/Theme Builders Used:

   • If you are using a Page/Theme Builder, please provide its name.

   • Examples: Ultimate Blocks, Spectra, Beaver Builder, SiteOrigin Page Builder, Gutenberg, Themify Builder, Live Composer, Elementor, Divi, Stackable, Visual Composer, WP Bakery

We may have follow-up questions to assist you with your request. This may include, for example:

1. Debug code: Please enable debug mode and send us the resulting code.
   --> You included this in the regular documentation above, so you might want to refer to it

2. API Keys: API keys for your account to replicate specific issues.

Solutions for Common Plugin Issues

Here you will find an overview of the most common difficulties that may arise when using the plugin, along with solutions on how to resolve them.

Related Guides

• Embedding an iFrame in a WordPress Website

• Creating iFrame Code and Integrating it into the Website

• edoobox API

Keywords for this guide

WordPress ¦ Shortcode ¦ Shortcode Pro ¦ Plugin ¦ Inline Code ¦