Set up credentials
You generate an Affinity API key from the Manage Apps page in your Affinity settings. You need the Generate API Key permission, and API access requires a Scale, Advanced, or Enterprise plan.1
Open Settings
Log in to Affinity and open Settings.
2
Go to Manage Apps
In the left navigation, select Manage Apps.
3
Create a new API key
Click + New App (or Create New API Key). Enter a descriptive
Name and an optional Description for the integration.
4
Copy the API key
Click Add App to generate the key. Copy the secret immediately, as it is
shown only once, and store it securely.
Each user can have only one active API key at a time. Creating a new key
revokes the existing one. Keys are also automatically revoked when a user is
deactivated.
Connect to Adapt
1
Open Integrations
In Adapt, go to Settings > Integrations.
2
Find Affinity
Search for Affinity and select it from the catalog.
3
Start the connection
Click Connect to open the connection form.
4
Add your credentials
Enter the values you gathered above, then click Add connection:
You can rename the connection and choose whether it is shared with your
organization or kept personal to you.
5
Test the connection
Ask Adapt to list the companies in one of your lists.
Security
- Credentials are encrypted at rest with AES-256
- The API key inherits the permissions and data access of the user who created it, so use an account scoped to only what you need
- Optionally define an IP allowlist on the key to restrict where it can be used
- Never share the API key publicly or commit it to source control