The Accumulus Subscription Commerce System allows you to fully automate the entire subscription life-cycle, including customer on-boarding and change processes. The information below is intended for developers wanting to integrate a company's website and backend servers with the Accumulus Subscription Commerce System. All customer touch-points can be fully customized to match the company's brand and for an optimal user experience.

Use our ready-made Javascript plug-ins to get started quickly with your existing website. Simply plug in our widget(s), configure the subscription offer(s), merchant account and start signing up customers. Using the widgets you can still make many customizations to your signup experience.

For full fledged access, the Accumulus API allows for automated system to system interaction to customize the integration. Common scenarios are signup and provisioning automation. We provide both an over-the-wire API using either {JSON} or <XML> formatting, as well as programming language specific SDKs for added convenience. The following language specific SDKs are currently available: Java, .NET, Python, PHP, Ruby.

Java SDK     .Net SDK      Python SDK     PHP SDK    Ruby SDK 

 

Select an integration topic below:

Integration and Customization

The plug-in signup form can easily be plugged into any existing website or mobile application. It is highly configurable and can be themed to match your website's branding for a seamless customer experience.

The signup widget can be directly integrated into your website or be used standalone via an iFrame. Below is an example of the the signup form integrated directly into an existing site:


Accumulus Hosted Signup

The image below shows an example of the mobile plug-in signup widget:

Mobile Signup Widget

The image below shows an example of the desktop plug-in signup widget:

Desktop Signup Widget

For more information on how to integrate the plug-in signup widgets, click here.

The plug-in customer portal can easily be plugged into any existing website or mobile application. It is highly configurable and can be themed to match your website's branding for a seamless customer experience.

The portal can be directly integrated into your website or be used standalone via an iFrame. The image below shows an example of the mobile plug-in customer portal widget.

 

Mobile Layout

 

 

 

 

Desktop Layout

 

The image below shows an example of the desktop plug-in customer portal widget.

 

 

For more information on how to integrate the plug-in customer portal widget, click here.

You can configure notifications to be sent to your customers at different times in the subscription lifecycle. For example, a welcome e-mail may be sent when a customer signs up and a cancellation e-mail may be sent when a subscription is cancelled. The Accumulus notification system uses editable templates to allow you to fully customize the contents of these notifications.

The templates contain both the text for the notification and tokens which are replaced with your company and customer data when generating the notification. This is analogous to a mail merge in which certain parts of a message are filled in with customer specific information. Each notification template has a number of tokens which are relevant to the notification. Tokens are identified by placing a "$" at the beginning and the end of the token name. For example $CustomerName$ is the token that will be replaced with the actual customer name when generating the notification. Below is a list of the notification templates and by following the links, you can find the associated tokens for each.

Refer to the advanced template topics page for information on advanced template control flow such as looping as well as formatting of tokens.

The following diagram depicts a typical API-based signup interaction:

API Based Signup

After the customer fills in and submits the required signup information to the company's web server, a signup request is sent to the Accumulus API. In processing this request, the Accumulus system verifies the credit card, creates the customer and subscription records, and sends a welcome e-mail to the customer on behalf of the company. In addition to calling the API for creating a new signup, the API can also be used to create, update and retrieve various other data. Detailed information on the various API calls can be found here:

Once you have configured your provisioning endpoint within the administrative application (under Settings->Integration), your endpoint will be called when customer or subscription information changes, allowing you to automatically provision or de-provision the specified product(s) and/or service(s). An event is generated and transmitted to a configured server for provisioning purposes when any of the following has occurred:

  • A new subscription has been created
  • An existing subscription has been updated
  • The status of an existing subscription has changed
  • A new customer has been created
  • An existing customer has been updated
  • The status of an existing customer has changed
  • A Ping event has been manually triggered

The following diagram depicts the provisioning event flow:



Provisioning Events

For detailed information about the individual provisioning events, click here.

The Accumulus back-office integration framework allows for reliable two-way integration of CRM, Accounting and other external systems. Use existing systems you are already familiar with and enable efficient access to the latest customer and payment information for your subscription business.

plug-and-play integration

Use one of our pre-built adapters or create your own. For more detailed information on the integration framework, please contact Accumulus support at support@accumulus.com.


For additional information on integrating Accumulus, please contact us at: integration@accumulus.com