API integration with Connectif

API integration is the option for custom integration with Connectif It offers full control over the data sent but only allows you to synchronize ContactsProductsPurchases and Vouchers. All other events must be integrated using one of the other options – HTML tags or JavaScript events.


To perform this type of integration, you will need an expert with programming knowledge, to obtain data from your ecommerce and make HTTP calls to a REST API.


Before you start: advantages and limitations of an API integration


  • It does not depend on the client, as it is an HTTP call where you can control the response received to ensure that the event arrived and was processed correctly.
  • It allows for mass imports, while other options are always updated one by one.

The possible limitations of an API integration are as follows:

  • It requires an IT department able to make the necessary Connectif API calls.
  • There is a maximum number of API calls per minute, so for mass operations we recommend using the import API, where a single call can synchronize multiple elements.
  • It is not possible to integrate all events through the API – you’ll need to combine this with one of the other integration options.

Learn how the Connectif API works in this article.


How to integrate Connectif via API

1. Add Connectif JavaScript

Configure the Connectif JavaScript on the website to load on all pages and integrate via events.

2. Synchronize via API

Configure the synchronization of information about: 

  • Contacts: para to register the data of visitors to the ecommerce site.
  • Products: to synchronize the catalog.
  • Purchases: to describe purchases made by customers
  • Vouchersto synchronize voucher codes and their uses.

3. Synchronize all other events by another method

3.1. HTML tags rendered on the server or the client:


The synchronization of the product catalog will be made via API, so you will need to disable automatic synchronization and verification. To send the "Contact has visited product" event, it is not necessary for the HTML to be rendered on the server.

3.2. Events sent via JavaScript:

5. Configuring Web Push notifications

To complete the integration you will also need to configure the Service Worker to receive Web Push subscriptions and send notifications to your contacts.

6. Validate the integration

Once you’ve implemented the sending of information to Connectif, the next step is to confirm that the integration has been carried out correctly.



You’ve reached the end of the tutorial.

Do you have questions?
Don’t forget, our Connectif specialists are here to help you. To contact them, just open a Support ticket by clicking the blue “Help” button on your dashboard.


Keep learning!

To make the most of your Connectif account, we recommend reading these articles next:

Was this article helpful?
0 out of 0 found this helpful