Skip to main content

Authorization

Follow this guide to create a new Affinity CRM credential that will allow Nexla to authenticate to and exchange data with your Affinity CRM account.
affinity_api_auth.png

Affinity CRM

Prerequisites​

Before creating an Affinity CRM credential in Nexla, you need to obtain your API key from your Affinity account. This credential authenticates Nexla with the Affinity API and should be kept secure.

Obtain an Affinity API Key​

  1. Sign in to your Affinity account.

  2. Navigate to Settings in your Affinity account to access the settings page.

  3. Locate the API section in the settings menu. This section contains your API credentials and access tokens.

  4. Generate or copy your API Key. The API key is a secret token that authenticates API requests and provides access to your Affinity account data. The API key is used with basic authentication, where the username is set to "x" and the password is your API key.

    Your API key provides full access to your Affinity account data through the API. Keep your API key secure and do not share it publicly or commit it to version control systems. If you suspect your API key has been compromised, regenerate it immediately in your Affinity account settings. For detailed instructions on obtaining your API key, see the Affinity support documentation.

For additional information about Affinity API authentication and credential management, see the Affinity API documentation.

Create an Affinity CRM Credential​

  • To create a new Affinity CRM credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Affinity CRM

AffinityCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Configuration​

  1. Enter your Affinity API key in the API Key field. This key authenticates Nexla with the Affinity API and should match the API key obtained from your Affinity account settings. The API key is used with basic authentication, where the username is set to "x" and the password is your API key.

    The API key provides full access to your Affinity account data through the API. Keep your API key secure and do not share it publicly or commit it to version control systems. Affinity uses basic authentication with the API key, which allows Nexla to make authenticated requests to your account.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.