Encounter CSS API for WordPress User Guide

Video Overview

Installation Guide

  1. Install or upgrade to the latest version of WordPress.
  2. Using an FTP client, add the “encounter-api” plugin folder to the WordPress plugins folder, typically /wp-content/plugins/
  3. Navigate to the Plugins section the WordPress control panel.
  4. Activate the Encounter API plugin.
  5. Navigate to the Pages section the WordPress control panel.
  6. Choose a page where you would like the Encounter content to be displayed.
    Note: If the page that you select has any child pages, those pages will no longer be accessible from your website.
  7. Locate the metabox titled “Encounter CSS”. The Encounter CSS metabox accepts the following attributes:
    • Enable on this page – enables the Encounter API on this page
    • Title Suffix – text that will be appended to the auto-generated page <title> attribute
    • API Token – the API token for this website
    • Section ID – the ID for this website section
  8. Check the “Enable on this page” box, enter the API Token, Section ID, and Title Suffix (optional).
  9. Disable any SEO plugins on Encounter CSS pages so that the title, description, keywords, and canonical links are not overwritten.
  10. If the theme uses the wp_list_pages or wp_nav_menu functions, sub-navigation menus will be automatically be generated by the plugin. If the theme does not use either of these functions, you must manually add a sub-navigation menu to the Encounter CSS page.

Suggestions for Better SEO

  • Keep the Encounter page/section as close to the website root as possible.
  • Name the Encounter page/section using the name of the product or service you are trying to market.
  • Make sure the the Encounter page/section can be indexed by search engines by disabling any SEO plugins and removing any “noindex” meta or “canonical” link tags from the page.
  • Add links to the Encounter content throughout your website. Main navigation, sub-navigation, product / service pages, and blog articles offer great link opportunities.
  • Add location information to the Title Suffix meta box option. For example: “Website Title – City, State”

Troubleshooting Tips

The Encounter API WordPress plugin has been tested with a variety of theme and plugin combinations. However, it’s impossible to plan for issues that may arise due to conflicts with all third-party themes or plugins.

If you are experiencing an issue with the Encounter plugin, try the following steps to troubleshoot the problem:

  • Double check that the API key and Section ID have been entered correctly.
  • Make sure that the latest version of WordPress is installed.
  • Switch to the TwentyFifteen theme that is installed by default with WordPress.
  • Disable all plugins.

The Encounter plugin should begin working properly after taking these steps.

Enable the website theme and test again. If the Encounter API stops working, then there is a conflict with the website theme. Enable WP_DEBUG in the wp-config.php file and also check the server error log for details about the issue.

If Encounter is working with the website theme, then continue testing plugins. Enable each plugin one by one until you find one that is causing the conflict. If you find a plugin conflict, enable WP_DEBUG in the wp-config.php file and also check the server error log for details about the issue.

Have more questions? Submit a request