Overview

The Connect Web Services are RESTful APIs that provides programmatic access to the data visible in the Connect User Interface. The web services are provided as a Java Web Application: brickstapi.war. The brickstapi.war web application can be deployed on the same server as the Connect API or it may be deployed separately on a single server or a cluster of servers. The API calls generally consume and return JSON objects. In this guide, we will assume that the web services are deployed at https://example.com/brickstapi.

The web services uses HTTP BASIC authentication over SSL connections. The same username and password are both used to log into the Connect user interface, and to authenticate to the web services. The web services should not be accessible over unencrypted http connections due to the insecurity of HTTP BASIC authentication.

Customer Services

The Customer Services provide access to customer profile data (attributes and preferences) and Messaging History. In addition there are entry points to manage subscriptions to Conversations.

List Services

The List services allow you to define and manage the following type of objects:

Conversations -- the subscriber lists used in Campaign targeting.
Audience Models -- the definitions used in Campaign targeting to filter the Conversation subscribers.
Segmentation Models -- the definitions used in Campaign targeting to partition the Conversation subscribers into segments.

Campaign Services

Campaign Services allow campaigns to be defined and launched.

Event Services

Event Services allow events to be submitted, which will invoke event-triggered campaigns.