Monetate Personalization Engine Connector Setup Guide
This article describes how to set up the Monetate connector.
Requirements
- Monetate Account
- API Username & API Keys
- Data Schema
Supported actions
| Action Name | Trigger on Audience | Trigger on Streams |
|---|---|---|
| Create or Update Data Record | ✓ | ✓ |
Configure settings
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article.
To configure your vendor, follow these steps:
- In the Configure tab, provide a title for the Connector instance.
- Enter your API Username, which can be found under Settings > Sites > API Keys of your account.
- Provide your Private Key matching the registered public key in your account. The private key must be generated with an RSA algorithm and transformed to PEM PKCS #8 format. For more information, see: API Keys Overview and the Generating API Keys section below.
- Provide your API Client ID, which can be found under Settings > API Documentation > Monetate Data API > Base URL of your account. For example, if the URL is
https://api.monetate.net/api/data/v1/abc/production/, then the client ID isabc. - Click Test Connection to verify API connectivity with the provided credentials.
Generating API keys
To ensure secure communication, Monetate API uses public and private key pairs. Key pairs can be generated with a free and widely available OpenSSL command line tool.
Run the following commands in order:
openssl genrsa -out my_key.pem 4096openssl pkcs8 -topk8 -inform PEM -outform PEM -in my_key.pem -out my_private_key.pem -nocryptopenssl rsa -in my_key.pem -pubout -outform PEM -out my_public_key.pem
Explanation of each command:
- Generate a new key using RSA algorithm (4096-bits key size) in traditional format.
- Convert key in traditional format to PEM PKCS #8 format. This is your private key.
- Output a public key in PEM format from key in traditional format. This is your public key.
The above example names the generated key files as my_key.pem, my_private_key.pem and my_public_key.pem, but these are arbitrary and can be named as you see fit.
Once generated, open the files in a text editor and copy the key values accordingly. Register the public key in your Monetate account and provide its private key in the connector configuration screen.
Action settings - parameters and options
Click Next or go to the Actions tab. It’s where you’ll set up actions to trigger.
This section describes how to set up parameters and options for each action.
Action: Create or Update Data Record (Real-Time)
Parameters
| Parameter | Description |
|---|---|
| Schema | (Required) Select schema in which to create or update records. |
| Data Record | (Required) Map attributes to data record fields. If a record with the primary key field value already exists in the schema, its data will be updated. Schemas of type event require an event time type field. If not mapped explicitly, field value will default to now. Date attributes will be converted to ISO 8601 format: YYYY-MM-DDThh:mm:ss. |
For more information, see: Engine API: Sending Data.
Action: Create or Update Data Record (Batched)
| Parameter | Description |
|---|---|
| Schema | (Required) Select schema in which to create or update records. |
| Data Record | (Required) Map attributes to data record fields. If a record with the primary key field value already exists in the schema, its data will be updated. Schemas of type event require an event time type field. If not mapped explicitly, field value will default to now. Date attributes will be converted to ISO 8601 format: YYYY-MM-DDThh:mm:ss. |
Vendor documentation
This page was last updated: January 24, 2020