Connectors

Overview

Connectors are used to integrate MarigoldLoyalty with other Marigold applications, and with third-party platforms. Connectors contain the information needed to manage that integration, such as API endpoints, login credentials, etc. The collection of settings and properties are saved as a reusable asset called a Connection Profile.

Access

To access the Connectors screen, select Admin from the Main Navigation Menu, then select Integrations > Connectors from the Sub-Category menu.

Features

The Connectors screen provides the following features related to managing your Connection Profiles:

Create a New Connection Profile

To create a new Connection Profile:

  1. Click the tile representing the type of Connection Profile you want to create. The platform displays a list of existing Connection Profiles of the selected type.

  2. In the "Label" field, enter the name of the new Connection Profile.

  3. Click Create. The "Connection Profile" pop-up window is displayed. The properties available within this window will vary depending on the Connector type:

To create a Connector to Marigold Engage+:

  1. The "Label" field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Label value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  3. In the "Endpoint" field, enter the appropriate API endpoint based on your region. Typically for a Messaging Connector, you'll use the Advanced Event Trigger API, which uses the following endpoint depending your region:

  • North America: https://aet.eccmp.com/services2

  • Europe: https://api.ccmp.eu/services2

  • Japan: https://api.marketingsuite.jp/services2

  1. In the "Username" field, enter the Consumer Key for the Messaging system user.  

  2. In the "Password" field, enter the Consumer Secret for the Messaging system user. By default, this value is obscured; optionally click show to view the value.

Note: The Username and Password values can be found within Messaging on the API Keys screen. Please see the Messaging Online Help for more details.

  1. In the "Token Expiration" field, enter the duration of the authentication token.

  2. Click save.


To create a Connector to Marigold Engage:

  1. The Label is the display name. Use a clear name, as this is the connector label name that will be used in triggered actions afterwards.

  2. The Internal Name is used in API calls and is automatically populated based on the 'Label' value. This field is not editable by default. To edit the Internal Name, check the 'Edit Internal Name' box.

  3. The API Client ID is the API key coming from Marigold Engage. Copy the value from the Service Accounts section in Engage's Admin Configuration and paste it into this field.

  4. The API Client Secret is the API key secret coming from Marigold Engage. Copy the value from the Service Accounts section in Engage's Admin Configuration and paste it into this field.

  5. The Engage Organization is the name in which the Transactional Journeys and messages are located.

  6. The Engage Domain is the domain for the API call to be triggered (e.g., https://subdomain.domainname.com).

  7. Click save.


To create a Connector to an FTP Server:

  1. The "Label" field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Label value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  3. In the "FTP Host" field, enter the FTP server filepath.

  4. In the "FTP Port" field, enter the desired server port.

  5. In the "Username" field, enter the FTP server username.

  6. From the "Auth type" drop-down menu, select either:

  • Password: In the "Password" field, enter the FTP server password.

  • Public Key: From the "Private Key File" drop-down menu, select an Encryption Key. 

Note: EDP supports the use of SSH2 (Secure Shell protocol version 2) for importing and exporting data. To use SSH2, you must create an Encryption Key that uses "RSA Private Key" as the encryption type, then assign that Encryption Key to an SFTP Connection Profile as described above. Then, select that Connection Profile for your Import and Export Definitions in EDP. 

  1. In the "Root Path" field, optionally enter the root path to the desired location on the FTP server. This value will be used as a prefix for all objects that use this Connection Profile.

  2. Click save.


Amazon's Simple Storage Service (S3) allows you to store and retrieve data, at any time, from anywhere on the web. This service uses the concept of a container called a "bucket" to store data. You can store an infinite amount of data in a bucket, and download it whenever you need.

Note: For more information on Amazon S3, please see the Amazon S3 User Guide. 

You can configure buckets so that they are created in a specific AWS Region. The combination of an optional prefix, the bucket name, and the region together comprise the URL for the bucket. For example, let's say you have an object named cheetah.jpg stored in the awsexamplebucket1 bucket in the US West (Oregon) Region. This object is addressable using the URL: https://awsexamplebucket1.s3.us-west-2.amazonaws.com/cheetah.jpg.

To create a Connector to an Amazon S3 Bucket:

  1. The "Label" field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Label value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  3. In the "AWS Access Key" field, enter your Amazon Web Services (AWS) Access Key ID. This ID is a 20-character, alphanumeric string that uniquely identifies an AWS account.

  4. In the "AWS Secret Key" field, enter your AWS secret access key. This key is a 40-character string. 

  5. In the "Bucket" field, enter the name of the Amazon S3 Bucket.

  6. In the "Root Path" field, optionally enter a value used as a prefix for all objects that use this Connection Profile.

  7. From the "Region" drop-down menu, select your AWS region.

  8. Click save.


To create a Connector to an HTTP API endpoint:

  1. The "Label" field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Label value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  3. In the "Base URL" field, enter the URL for the API endpoint.

  4. Optionally, in the "Grant Type" field, enter the OAuth grant type, such as Authorization Code or Refresh Token, for example.

  5. In the "Client ID" field, enter the authorized user's username.

  6. In the "Client Secret" field, enter the user's password. By default, this value is obscured; optionally click show to view the value.

  7. In the "Scope" field, enter the scope of the request.

  8. Click save.


To create a Connector to the Salesforce Marketing Cloud:

  1. The "Label" field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Label value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  3. In the "Request URL" field, enter the URL used to get an OAuth token from Salesforce. This URL is usually unique per Salesforce client.

  4. Optionally, in the "Grant Type" field, enter the OAuth grant type, such as Authorization Code or Refresh Token, for example.

  5. In the "Client ID" field, enter the authorized user's username.

  6. In the "Client Secret" field, enter the user's password. By default, this value is obscured; optionally click show to view the value.

  7. Optionally, in the "Scope" field, enter the Scope value. This parameter is used to access additional permissions in the returned token.

  8. In the "Account ID" field, enter your Salesforce account ID.

  9. Click save.


To create a Connector to Sparkfly:

  1. The "Label" field is populated with the value you entered above; optionally edit this value.

  2. The Internal Name is automatically populated based on the Label value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  3. The "Endpoint" field is pre-populated with the standard endpoint for requesting a Sparkfly authentication token. Optionally enter a different endpoint in this field.

  4. In the "Client ID" field, enter the authorized user's username.

  5. In the "Client Secret" field, enter the user's password. By default, this value is obscured; optionally click show to view the value.

  6. In the "Token Expiration" field, enter the duration of the authentication token. The default duration is 24 hours (86,400 seconds).

  7. Click save.

View or Edit Connection Profile Details

To view or edit a Connection Profile:

  1. Click the tile representing the type of Connector you want to edit. The platform displays a list of existing Connection Profiles of the selected type.

  2. Click the desired Connection Profile. The Connection Profile Details screen is displayed. See Connection Profile Details for more information.