Integration

integration

Integrating Captina

Option 1: WordPress Plugin

The recommended method of integrating Captina is to use WordPress for your website.

WordPress not only makes it easy to integrate Captina’s consumer-facing features (web store, club signup and maintenance, email preferences, and so forth); it also makes it easy to make changes to your website to keep it current. It also provides a common look-and-feel to your entire site, and makes changes to look-and-feel easy to do.

The basic plug-in syntax for Captina in WordPress is very straightforward. You simply place the following “shortcode” tag on your WordPress page where you want to captina module to appear:

[captina content="module_name" /]

or, use this syntax if you need to include some content inside the tag (see below):

[captina content="module_name"]
     - some CSS or JS content here -
[/captina]

There is also a special form if you need to include inline CSS or JS content separately from a captina module:

[captina content="inline"]
     - some CSS or JS content here -
[/captina]

To fully-integrate Captina into your WordPress site, you will need six pages, one for each of the following modules:

  • order

    – the basic order page

    This page requires the following setting in WordPress’ Page Editor:

    1. Permalink set to
      'order'
    2. Page template set to “Full width (no sidebar)” or the equivalent
  • confirm_order

    – the page showing the order summary

    This page requires the following settings in WordPress’ Page Editor:

    1. Permalink set to
      'confirm_order'
    2. Page template set to “Full width (no sidebar)” or the equivalent

    Additionally, you should remove this page from the Navigation menu in your chosen theme’s settings.

  • process_order

    – the page displayed when an order has been completed

    This page requires the following settings in WordPress’ Page Editor:

    1. Permalink set to
      'process_order'
    2. Page template set to “Full width (no sidebar)” or the equivalent

    Additionally, you should remove this page from the Navigation menu in your chosen theme’s settings.

  • email_preferences

    – the page where people on your mailing list can manage what emails they receive

    This page requires the following settings in WordPress’ Page Editor:

    1. Permalink set to
      'email_preferences'
    2. Page template set to “Full width (no sidebar)” or the equivalent

    Additionally, you should remove this page from the Navigation menu in your chosen theme’s settings.

  • club

    – the page introducing your wine club(s) and from which the login and signup process begin

    This page requires the following settings in WordPress’ Page Editor:

    1. Permalink set to
      'club'
    2. Page template set to “Full width (no sidebar)” or the equivalent
  • my_club

    – the member’s personal club page, where they can manage their membership

    This page requires the following settings in WordPress’ Page Editor:

    1. Permalink set to
      'my_club'
    2. Page template set to “Full width (no sidebar)” or the equivalent

    Additionally, you should remove this page from the Navigation menu in your chosen theme’s settings.

  • get_catalog_summary

    – this will provide the available catalog items, in one of two formats.

    There are a couple of parameters for this module.

    1. sections

      – This is a list of the names of the one or more Catalog sections you want included in the listing, separated by semi-colons. For example,

      • sections="Estate Wine;Library Wines;Tastings"

      If you omit this parameter, all catalog sections will be listed.

    2. output_format

      – This parameter determines how the catalog is returned. There are two options:

      • output_format="divs"

        – the catalog will be returned in a series of HTML <div> tags, one per catalog section,
        with the name and price of each item in the section; each item, if clicked, will take you to the webstore with that item highlighted.

      • output_format="json_object"

        – the catalog will be returned as a JSON object, which you may then use to generate HTML on-the-fly
        by using your own Javascript.

      For details on the contents of the returned data, please consult the Captina Store Development Guide.

    We will be happy to guide you on this or any other aspect of WordPress integration.

You must have pages for the first three modules in order for basic ecommerce to function, and you must support email_preferences for the requried CAN-SPAM Act “unsubscribe” functionality.

The closing tag is essential!

There are two ways to close the shortcode tag; if you are just including a module, use

[captina content="module_name" /]

If you need to include your own CSS, javascript, or custom HTML along with the module, then use a separate closing tag like this:

[/captina]

Normally, anything between the opening and closing tags is inserted into the resulting HTML — after the module and without modification by WordPress. You may use this to include inline CSS and Javascript, as well as include page-specific styles, both before and after the primary module.

Pages containing Captina plug-ins should be full-width.

We’re happy to assist you or your designer or programmer in getting Captina up and running in your WordPress site, including providing sample CSS as a starting point. There is no charge for this.

We’ve added new features to the Captina plug-in that allow you to create customized pages to feature products and display extensive product details. Full documentation of these features can be found in our Captina Shortcode captina_product Usage Guide.

Note: based on our experience, we recommend the free Responsive theme as a starting point. It adapts pages to mobile devices extremely well, and is very flexible in terms of layout and designer-control.

Option 2: Direct Integration

The other option is to let Captina create the pages for you. This is more difficult from a design perspective, but does provide you with extremely fine-grained control over every aspect of Captina’s public-facing pages.

If you are interested in this model, please talk with us. Depending on the complexity of the integration we may have to charge you for our time, although we will make every effort to keep those charges to a minimum.