RESTFUL API - GATORMAIL

For developers that want to integrate to the Gator marketing platform then the RESTFUL API is available through your SSO (single sign on) account using oAuth2. 

The full API details can be found at https://api.communigator.co.uk

E-Marketing Example

 

1. Create Campaign

A campaign effectively represents an email campaign with an associated audience

https://communigator.github.io/API-Documentation/#operation/gatormail_addCampaign

 

2. Create the Audience

Audience of email contacts is called a group in GatorMail and is attached to an email campaign, the below explains how to add the group to your campaign

2.1 Add a group (storing the group id returned)

https://communigator.github.io/API-Documentation/#operation/gatormail_addGroup

2.2 Add contacts to the created group (using the group id returned in 2.1):

https://communigator.github.io/API-Documentation/#operation/gatormail_groupIncludedContactpost

2.3 Update the campaign created in step 1 with the group id returned in 2.1:

https://communigator.github.io/API-Documentation/#operation/gatormail_updateCampaign

 

3. Mappings:

GatorMail allows you to map contact fields from your 3rd party system/CRM to its own contacts.

3.1 Clear all schema entities and attributes:

https://communigator.github.io/API-Documentation/#operation/gatormail_deleteSchema

3.2 Addschema entities and attributes to GM to allow for mappings:

https://communigator.github.io/API-Documentation/#operation/gatormail_postSchemaEntityhttps://communigator.github.io/API-Documentation/#operation/gatormail_postSchemaAttribute

3.3 Check for a publish request from the user of GM after configuring the mappings schema:

https://communigator.github.io/API-Documentation/#operation/gatormail_getIntegrationRequests

3.4 After applying the schema reset the schema status to notify the user it's done:

https://communigator.github.io/API-Documentation/#operation/gatormail_getIntegrationRequestSatisfied

3.5 See if the schema mappings have been published:

https://communigator.github.io/API-Documentation/#operation/gatormail_getIntegrationRequests

3.6 If so pull them down:

https://communigator.github.io/API-Documentation/#operation/gatormail_getSchema

3.7 Mark as complete to let the GM user know:

https://communigator.github.io/API-Documentation/#operation/gatormail_getIntegrationRequestSatisfied

 

4 DataFeed:

All email campaign activity data is queued into a table and can be accessed using the following calls.
These activities make up email opens, clicks, downloads, unsubscribes, survey answers, bounces, event invites

4.1 If needed the client can set and get the data feed options:

https://communigator.github.io/API-Documentation/#operation/gatormail_getDatafeedOptionshttps://communigator.github.io/API-Documentation/#operation/gatormail_postDatafeedOptions

4.2 Retrieve a batch of data feed records:

https://communigator.github.io/API-Documentation/#operation/gatormail_getDatafeed

4.3 Mark them as processed when complete:

https://communigator.github.io/API-Documentation/#operation/gatormail_getDatafeedBatchIdentifier

 

0 Comments

Add your comment

E-Mail me when someone replies to this comment