Introduction
This document outlines the integration between the Annex Cloud platform and Bronto ESP (Email Service Provider) through the Bronto API. It details the functions available for managing contact data within the Bronto ESP system, such as adding, updating, and validating contacts. By utilizing these functions, Annex Cloud can interact with Bronto to streamline marketing workflows and enhance communication with contacts through the ESP.
Default URLs:
Staging Path: https://api.socialannexstaging.com/brontoesp/BrontoAPILibrary.php
Production Path: https://api.socialannex.com/brontoesp/BrontoAPILibrary.php
Available Functions:
validateAccessToken($accessToken)
This function validates the access token for Bronto ESP.
| Parameter Name | Parameter Description | Example |
|---|---|---|
| $accessToken (required) | The access token provided by the Bronto client. | c176b5f2-f903-4313-a247-57c45d7a7a7a |
addOrUpdateContact($emailId, $listId, $fieldData)
This function adds a new contact or updates an existing contact in the Bronto ESP database.
| Parameter Name | Parameter Description | Example |
|---|---|---|
| $listId (required) | The ID of the contact list. | 0bd903ec0000000000000000000000172aec |
| $emailId(required) | The member’s email address. |
somebody@gmail.com |
| $fieldData (required) | An array of field mappings that contain information about the contact. |
Array ( [userName] => Madhuri Natu [address] => JM Road, Pune [question] => Test1 [qusDbAddDate] => 2019-10-30 ) |
addContact($emailId, $listId, $fieldData)
This function is used to add a contact to the Bronto ESP database.
| Parameter Name | Parameter Description | Example |
|---|---|---|
| $listId (required) | The ID of the contact list. | 0bd903ec0000000000000000000000172aec |
| $emailId(required) | The member’s email address. |
somebody@gmail.com |
| $fieldData (required) | An array of field mappings that contain the contact’s details. |
Array ( [userName] => Madhuri Natu [address] => JM Road, Pune [question] => Test1 [qusDbAddDate] => 2019-10-30 ) |
updateContact($emailId, $listId, $fieldData)
This function updates an existing contact in the Bronto ESP database.
| Parameter Name | Parameter Description | Example |
|---|---|---|
| $listId (required) | The ID of the contact list. | 0bd903ec0000000000000000000000172aec |
| $emailId(required) | The member’s email address. |
somebody@gmail.com |
| $fieldData (required) | An array of field mappings to update the contact’s information. |
Array ( [userName] => Madhuri Natu [address] => JM Road, Pune [question] => Test1 [qusDbAddDate] => 2019-10-30 ) |
checkUserExist($emailId, $listId, $pg_no)
This function checks if a contact exists in the Bronto ESP database.
| Parameter Name | Parameter Description | Example |
|---|---|---|
| $listId (required) | The ID of the contact list. | 0bd903ec0000000000000000000000172aec |
| $emailId(required) | The member’s email address. |
somebody@gmail.com |
| $pg_no(required) | The page number for pagination. | $pg_no = 1 |
Example usage of class
// Create an instance of the BrontoAPILibrary class with the access token
$newUser = new BrontoAPILibrary($access_token);
// Add or update a contact
$resultArr = $newUser->addOrUpdateContact($email_id, $list_id, $fieldsData);
// Add a new contact
$resultArr = $newUser->addContact($email_id, $list_id, $fieldsData);