Connecting to AgileCRM

AgileCRM allows authentication to its API via Basic authentication.

Using Basic Authentication

Authentication to AgileCRM uses Basic authentication, using your login email address and API Key as User and Password connection properties. You may access the API Key from 'Admin Settings' > 'Deelopers & API' > 'API Key' > 'REST API'. Additionally, you will need to set the Domain, found in the URL of your AgileCRM account. For example if your AgileCRM account is acmeinc.agilecrm.com, then the Domain should be 'acmeinc'. Set the Domain in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\AgileCRM.apip;User=your_login_email;Password=your_rest_api_key;ProfileSettings='Domain=acmeinc';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.