Integrating Monetate
Capabilities
DataGrail's Monetate integration provides the following capabilities:
| Product | Capability | ||||
|---|---|---|---|---|---|
| Request Manager |
|
Before You Start
To successfully configure this integration, please ensure you have sufficient privileges:
- DataGrail User Role: Super Admin, Connections Manager
- Monetate User Role: API User
Find Your Retailer Short Name
Your Retailer Short Name is a unique account identifier used in all Monetate API paths. It is not visible in the Monetate UI — you must obtain it by submitting a support ticket to Monetate. Contact your Monetate account representative or submit a support request to receive this value before proceeding.
Generate an RSA Key Pair
Monetate uses RSA public-key cryptography to authenticate API requests. You must generate an RSA key pair: the Public Key is uploaded to Monetate (referred to as a "Public Key" in their API Keys settings), and the Private Key is entered in DataGrail to sign authentication tokens. These are two halves of the same key pair and are not interchangeable.
Generate a 2048-bit (or stronger) RSA key pair using your preferred tool. For example, using OpenSSL:
openssl genrsa -out monetate_private.pem 2048
openssl rsa -in monetate_private.pem -pubout -out monetate_public.pem
Store both files securely:
monetate_public.pem— uploaded to Monetate in the next stepmonetate_private.pem— entered in DataGrail when connecting
Create an API User in Monetate
- Log in to Monetate and select the settings icon, then select Sites.
- Select the API Keys tab.
- Select CREATE API USER.
- Enter a unique username in the name field — note it, as you will need it when connecting to DataGrail.
- Select API User as the user type, then select CREATE.
- In the left panel, select the user you just created, then select CREATE PUBLIC KEY.
- Paste the contents of your
monetate_public.pemfile into the Public Key text area. - Select SAVE.
Connect to DataGrail
- In DataGrail, navigate to Integrations and select Configure New Integration to search for Monetate.
- Enter your Retailer Short Name.
- Enter the Username you created above.
- Paste the full contents of your Private Key (
monetate_private.pem), including the-----BEGIN RSA PRIVATE KEY-----and-----END RSA PRIVATE KEY-----lines. This is the private half of the key pair — the corresponding public key was uploaded to Monetate in the previous step. - Optionally, enter a Dataset Name for the privacy deletion dataset. If left blank, DataGrail will use
privacy_deletion_requestsas the default. - Select Configure Integration.
Next Steps
Now that you've successfully connected the integration, check out the following resources:
- Synchronous vs. Asynchronous Integrations
- Whole Record Deletion
- Access Request Lifecycle
- Deletion Request Lifecycle
Troubleshooting
If you are unable to successfully connect the integration, review these common troubleshooting steps:
Connection fails with an authentication error
Verify that the Public Key uploaded to Monetate matches the Private Key entered in DataGrail. The keys must be a matching RSA pair. If you are unsure, generate a new key pair, upload the new public key to Monetate, and re-enter the new private key in DataGrail.
Connection fails with an invalid key error
Ensure the private key is pasted in full PEM format, including the header and footer lines (-----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY-----). The key must not contain extra whitespace or be truncated.
Ensure Required Permissions Are Granted on API Keys/Resources
DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.
Review Required Account Types and User Roles
If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.
See Before You Start to review these requirements.
Technical Details
The Monetate integration uses the Monetate API:| Access Type | Synchronous |
|---|---|
| Deletion Type | Asynchronous (Whole Record) |
API Documentation
Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.