Business Catalyst API Integration

Business Catalyst has developed an advanced web service enabling designers to programmatically export and import information to/from Business Catalyst platform to other systems. During the last 5 years Fortix has integrated many applications to/from Business Catalyst.

Business Catalyst offers 2 API (application programming interface) frameworks.

1. Notification API

This is a simple framework that you can setup so this system pings your external application when certain events happen. Events include an online shop purchase, a request for quote via your online shop, a new customer enquiry via one of your web forms and so forth.

To enable this feature, login to the Administration area and choose API Integration from the Admin menu (top-right). You will then need to enable the API Integration feature then allow up to 24 hours for this feature to be enabled. Once enabled you can then enter a different URL, corresponding to a web page on your web server to handle the various events. When any one of these events takes place the system will post to your web page. The system will post 2 variables called ObjectID and ObjectType.

ObjectID refers to the current internal ID assigned to the new enquiry or purchase. The ObjectType is not currently used, but refers to the type of action. E.g. A new case was created, a new order was created and so forth. Please note that notifications process is asynchronous and can take up to 10 minutes before they arrive at your application.

2. Web Services API

The web services API is an XML based framework that allows you to query the system and retrieve almost any type of data stored in your database. For example, using web services you can retrieve details about your customers, you can retrieve details for purchases including products purchased, payments received and their status. You can also undertake certain website actions. E.g. upload a new web page or retrieve a list of site-wide templates.

Showcase Business Catalyst API

Images of integration of FF into the Business Catalyst
Showcase of integrating Shemoves to Business Catalyst
Showcase of integrating Smoke Alarms into the Business Catalyst (maintaining the clients list for marketing)

Simple demonstration of managing customers via API
1. Project Management Application
2. Integration application showcasing different options of integration developed using PHP / MySQL.