RESTFUL API - GATORLEADS

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

 

oAuth Token and Secret

To retrieve an oauth token you will need to pass an Authorization header to the token endpoint in the following format:

Authorization: Basic [ENCODED_CLIENT+SECRET]

Where [ENCODED_CLIENT+SECRET] is your client id and client secret separated by a colon and Base64 encoded.

Please contact support or your account mgr to gain access to your clientid and secret. 

 

Example Request

Here is an example request (you will need to replace [SSO_USERNAME] and [SSO_PASSWORD] with your CommuniGator single sign on credentials and [ENCODED_CLIENT+SECRET] with your base64 encoded client id and secret).

curl -X POST http://oauth.communigator.co.uk/core/connect/token -H "Authorization: Basic [ENCODED_CLIENT+SECRET]" -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=password&username=[SSO_USERNAME]&password=[SSO_PASSWORD]&scope=openid%20GatorMailApi"

This will return an access token in the below format:

{"access_token":"hJJ0eXASDSsdsdKV1Q....","expires_in":3600,"token_type":"Bearer"}

 

Using the Access Token

You can then use this access token to call any of the GatorMail end points in the API documentation: https://communigator.github.io/API-Documentation/

To do so call the desired endpoint and pass along an Authorization header like so:

curl -X GET https://api.communigator.co.uk/mail/coinsglobal_testlz/campaign/1/100 -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-Type: application/json"

The tools/integration screen is unrelated to accessing the API and is only used if you have one of our CRM integrations setup.

 

GatorLeads: Website tracking integration examples

All website activities for leads identified by GatorLeads can be pulled back through the API endpoints below.

1 Tracked Links: (web site visitor / hits)

1.1 Retrieve a batch of tracked links:

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

1.2 Retrieve lead and company info for each tracked link where required:

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

1.3 Mark the tracked links as processed when complete:

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