May 17th, 2012

Modules

Modules are portions of the infusionWP plugin which can interact directly with external processes, such as Infusionsoft or a browser, without passing through the entire Wordpress initialization.

They can be used to quickly check on the status of your plugin, subscribers or to perform certain predefined actions.

The following is the list of the 9 built-in and supported infusionWP modules.

Supported Modules (9 items)

i4w_autologin  

i4w_check  

i4w_clearuser  

i4w_genpass  

i4w_license_check  

i4w_newuser  

i4w_showuser  

i4w_syncfields  

i4w_updateuser  

Supported Modules Syntax (9 items)

   [i4w_autologin]
Back to top   

Usage:

    • This module enables you to send your subscribers to a "Thank You page" and have them automatically log in.

    • For security reasons, this automatic login will only under specific conditions (invoice payment verification) unless the "force_login" is specified.

    • Unless the "force_login" option is used, the call to this module must be made following the completion of an order form.

    • We do not recommend using the "force_login" option if the user can see and/or copy the link as it could then be shared.

Example:


  • http://www.yoursite.com/?i4w_autologin=abc123

  • http://www.yoursite.com/?i4w_autologin=abc123&redir=http://www.yoursite.com/thankyou

  • http://www.yoursite.com/?i4w_autologin=abc123&force_login=abc123&redir=http://www.yoursite.com/thankyou

  • http://www.yoursite.com/?i4w_autologin=abc123&redir=http://www.yoursite.com/thankyou&nofirstlogin=1

Parameters:

  • i4w_autologin=abc123: This sets the action to be performed.

  • force_login=abc123: Additional parameter to bypass invoice and order processing verification.

  • redir=http://www.yousite.com/thankyou/: This specifies an alternate landing page upon login.

  • nofirstlogin=x: Any value can be specified, enabling you to override the "Page redirect on FIRST login" set in the "Plugin Options" panel.

Notes:

  • In all examples provided, 'abc123' stand for the first six characters of your Infusionsoft API key. These are used to authenticate the request.

   [i4w_check]
Back to top   

Usage:

  • This module is used to check the general status of your plugin installation.

  • If it doesn't produce an error or return a blank page, your plugin can generally be considered as correctly installed.

  • This module must be called manually by typing the URl in your browser.

Example:

  • http://www.yoursite.com/?i4w_check

Parameters:

  • None.

   [i4w_clearuser]
Back to top   

Usage:

  • This module enables you to delete a subscriber from your local Wordpress database

  • This module must be called through a 'Send an http post...' following an order form.

Example:

  • http://www.yoursite.com/?i4w_clearuser=abc123

Parameters:

  • i4w_clearuser=abc123: This sets the action to be performed.

Notes:

  • In all examples provided, 'abc123' stand for the first six characters of your Infusionsoft API key. These are used to authenticate the request.

   [i4w_genpass]
Back to top   

Usage:

  • This module will generate a password for a subscriber during the order form process.

  • Unless otherwise specified, the module will also create a local Wordpress user to capture the registration date.

  • If a password already exists in the designated Infusionsoft custom field, it will not be overwritten.

  • This module must be called through a 'Send an http post...' following an order form.

Example:

  • http://www.yoursite.com/?i4w_genpass=abc123

Parameters:

  • i4w_genpass=abc123: This sets the action to be performed.

  • autoreg=n: This parameter is used to prevent the Wordpress user from being created during the process.

Notes:

  • In all examples provided, 'abc123' stand for the first six characters of your Infusionsoft API key. These are used to authenticate the request.

  • The autoreg parameter was previously named "autologin". The name was changed to better reflect what it did and to minimize confusion with the i4w_autologin module.

   [i4w_license_check]
Back to top   

Usage:

  • This module is used to check the current license status of your plugin.

  • If "status = 1" is displayed, your license is in order.

  • This module must be called manually by typing the URl in your browser.

Example:

  • http://www.yoursite.com/?i4w_license_check

Parameters:

  • None.

   [i4w_newuser]
Back to top   

Usage:

  • This module is used to automate the creation of tags for the so-called "Magazine Subscription Model", which enables the system to prevent subscribers from seeing content published before they joined or for any months during which they were not members.

  • Please contact us prior to implement this membership model to ensure that it does what you need.

  • This module must be called through a 'Send an http post...' as part of a trigger process.

Example:

  • http://www.yoursite.com/?i4w_newuser=abc123

  • http://www.yoursite.com/?i4w_newuser=abc123&genpass=y

  • http://www.yoursite.com/?i4w_newuser=abc123&genpass=y&autologin=n

Parameters:

  • i4w_newuser=abc123: Determine the basic action to be taken.

  • genpass=y: Determines whether or not a random password should be generated.

  • autologin=n: Used to prevent the immediate creation of a Wordpress user

Notes:

  • In all examples provided, 'abc123' stand for the first six characters of your Infusionsoft API key. These are used to authenticate the request.

   [i4w_showuser]
Back to top   

Usage:

  • This module enables you to perform a basic check for a subscriber, based on a subscriber's email address or last name, as seen from the plugin's perspective.

  • The module displays up to 1000 subscribers.

  • If subscriber data is displayed it means that, through the API, the subscriber is visible to the plugin.

  • If the subscriber doesn't have a password assigned, a message to that effect will be displayed.

  • The '%' wild card may be used to query are range of possible subscribers.

  • This module must be called manually by typing the URl in your browser.

Example:

  • http://www.yoursite.com/?i4w_showuser=bob@infusionwp.com

  • http://www.yoursite.com/?i4w_showuser=%@infusionwp.%

  • http://www.yoursite.com/?i4w_showuser=keen

  • http://www.yoursite.com/?i4w_showuser=k%

Parameters:

  • i4w_showuser=xyz: Whereby 'xyz' can be a last name or an email address, and can include one or more '%' wildcards.

   [i4w_syncfields]
Back to top   

Usage:

  • This module provides a mechanism to synchronize two contact fields using a "Send Http post to another server" action.

  • Both regular and custom fields can be synchronized.

  • This module must be called through a 'Send an http post...' following an order form.

Example:

  • http://www.yoursite.com/?i4w_syncfields=abc123&source=_i4wpassword&target=Password

Parameters:

  • i4w_syncfields=abc123: Determine the basic action to be taken.

  • source=fieldname: Defines the name of the contact field to use to update another.

  • target=fieldname: Defines the name of the contact field to be updated with the value of the "source" field.

  • noblanks=1: States that "target" should only be overwritten if "source" is not empty.

Notes:

  • In all examples provided, 'abc123' stand for the first six characters of your Infusionsoft API key. These are used to authenticate the request.

   [i4w_updateuser]
Back to top   

Usage:

  • This module provides a mechanism to force a session cache refresh using a "Send Http post to another server" action.

  • This will cause the next page hit by a subscriber to automatically reload all session data from Infusionsoft.

  • This module is essentially the Infusionsoft-side version of the [i4w_data_refresh] shortcode.

  • This module must be called through a 'Send an http post...' following an order form.

Example:

  • http://www.yoursite.com/?i4w_updateuser=abc123

Parameters:

  • i4w_updateuser=abc123: Determine the basic action to be taken.

Notes:

  • In all examples provided, 'abc123' stand for the first six characters of your Infusionsoft API key. These are used to authenticate the request.