The objects available within our connector are accessible from the "cdata.suitecrm" module. In order to use the module's objects directly, the module must first be imported as below:

import cdata.suitecrm as mod

From there, the connect() method can be called from the connector object to establish a connection using an appropriate connection string, such as the below:

mod.connect("URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;")

Connecting To SuiteCRM V4.1 API

You can connect to SuiteCRM data via the V4.1 API by simply setting the following connection properties:

• Schema: Set this to suitecrmv4.
• Url: Set this to the URL associated with the SuiteCRM application, for example http://suite.crm.com.
• User: Set this to the user associated with the SuiteCRM account.
• Password: Set this to the password associated with the SuiteCRM account.

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in Caching Metadata.

Connecting To SuiteCRM V8 API

Before Connecting

Before you connect to SuiteCRM V8 API you will need to first configure it in your SuiteCRM instance. The API can be configured in SuiteCRM version 7.10+. To configure the API, please follow the steps written in the SuiteCRM JSON API docs, found here: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_before_you_start_calling_endpoints .

The SuiteCRM V8 API uses OAuth2.0 as its main method of authentication using 2 types of grant type, password or client credentials. Please see Using OAuth Authentication for a guide on how to connect with OAuth.