Overview
This guide explains how to securely connect your Salesforce org to the sanctions.io API using a Named Credential. This setup enables a secure, scalable integration, allowing you to perform searches and retrieve results smoothly.
Topics Covered
Retrieve Your API Token from the sanctions.io Portal
1. Log in to your sanctions.io portal.
2. In the left-side menu, click on API Settings.
3. If no tokens are listed, click + Create New Token to generate one. If tokens are already available, you can skip ahead to Step 5.
4. Select Production as the environment, then click Create Token to generate a new one.
5. Copy your API token. You'll use this in a later step.
Add your API Token to Salesforce
1. Open Salesforce Setup.
2. Search for 'Named Credentials'.
3. Within Named Credentials, select External Credentials. Then, click on an existing entry.
❗Note: Label names may vary depending on your organization's setup. If you're unsure, please check with your administrator.
4. Scroll down to the Principals section, where you’ll see an existing Principal listed. Under Actions, select Edit from the dropdown icon.
5. Click Add in the Authentication Parameters section.
6. Enter 'Token' as the Parameter Name and paste your 'API token' as the Value. Then, Save to store the credentials. Your 'API token' is now securely configured!
Provisioning Permissions
To ensure users can access and use the app correctly, they need to be assigned the appropriate permission set.
1. In Salesforce Setup, search for 'Permission Sets'.
2. On the Permission Sets page, locate the sanctions.io Admin permission set. This is the base set of permissions that grants users full access to the sanctions.io app’s features.
3. Within the sanctions.io Admin permission set, click Manage Assignments.
4. Click Add Assignments in the top-right corner.
5. Select the checkbox next to the user(s) you want to assign the permission set to. Then Next.
6. Select the desired expiration options, and click Assign.
7. On the next screen, review the Assignment Summary, then click Done to complete the process. The selected users now have full access to use the sanctions.io app's features.
We're here to help!
If you have any questions or require further assistance, please don’t hesitate to reach out to our support team.
-
Chat: Available directly in the portal
-
Email: help@sanctions.io