Basic Tab

Connecting to Suite CRM

Requirements for connecting to Suite CRM differ, depending on which version of the API your site is running.

Suite CRM V4.1 API

To connect to Suite CRM data via the V4.1 API, set these connection properties:

Schema: suitecrmv4.
URL: The URL associated with the Suite CRM application. For example, http://suite.crm.com.
User: The user associated with the Suite CRM account.
Password: The password associated with the user of the Suite CRM account.

Suite CRM V8 API

Suite CRM V8 uses the OAuth2 authentication standard. Before you connect to Suite CRM V8 API, you must ensure that is it properly configured to provide the OAuth2 private and public keys. For further information, see the SuiteCRM Developer Guide API V8 setup instructions.

Authenticating to Suite CRM V8 API

The Suite CRM V8 API uses OAuth2.0 as its authentication mechanism, based on either of two grant types: PASSWORD and CLIENT.

Authentication via OAuth requires the Schema to be set to suitecrmv8, and the creation of a custom OAuth application, as described in Creating a Custom OAuth Application.

Client Credentials Grant

To connect to Suite CRM V8 API, set these properties:

Schema: suitecrmv8.
AuthScheme: OAuthClient.
OAuthClientId: The client key returned during custom OAuth application creation. (See Creating a Custom OAuth Application.)
OAuthClientSecret: The client secret returned during custom OAuth application creation (See Creating a Custom OAuth Application.)
InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
URL: The base URL of your Suite CRM system. For example, https://suitecrmhost/.

Password Grant