Skip to main content

Authorization

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

Agile CRM

Prerequisites​

Before creating an Agile CRM credential in Nexla, you need to obtain your user email, REST API key, and domain name from your Agile CRM account. These credentials authenticate Nexla with the Agile CRM API and should be kept secure.

Obtain Agile CRM API Credentials​

  1. Sign in to your Agile CRM account.

  2. Navigate to Settings in your Agile CRM 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. Copy your User Email. This should be the email address of a user authorized to access the API. The email is used as the username for basic authentication.

  5. Copy your REST API Key. This is a secret key that authenticates API requests and provides access to your Agile CRM account data. The API key is used as the password for basic authentication.

  6. Identify your Domain Name. This is the subdomain portion of your Agile CRM URL. For example, if your Agile CRM URL is yourcompany.agilecrm.com, your domain name is yourcompany. The domain name is used to construct the API endpoint URLs.

    Your user email, REST API key, and domain name are required for all Agile CRM API operations. Keep these credentials secure and do not share them publicly or commit them to version control systems. For detailed information about Agile CRM API authentication, see the Agile CRM REST API documentation.

Create an Agile CRM Credential​

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

New Credential Overlay – Agile CRM

AgileCRM_Cred.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.

Authentication Configuration​

  1. Enter your Agile CRM user email in the User Email field. This should be the email address of a user authorized to access the API. The email is used as the username for basic authentication.

  2. Enter your Agile CRM REST API key in the REST API Key field. This key authenticates Nexla with the Agile CRM API and should match the API key obtained from your Agile CRM account settings. The API key is used as the password for basic authentication.

  3. Enter your Agile CRM domain name in the Domain (eg: yourcompany in yourcompany.agilecrm.com) field. This should be the subdomain portion of your Agile CRM URL. For example, if your Agile CRM URL is yourcompany.agilecrm.com, enter yourcompany. The domain name is used to construct API endpoint URLs in the format https://{domain_name}.agilecrm.com/dev/api/{endpoint}.

    The user email, REST API key, and domain name provide full access to your Agile CRM account data through the API. Keep these credentials secure and do not share them publicly or commit them to version control systems. Agile CRM uses basic authentication with the email and 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.