Version 25.3.9396

• Add the SuiteCRM Connector
• Authenticate to SuiteCRM
  • SuiteCRM V4.1 API
  • SuiteCRM V8 API
• SuiteCRM V4.1 Authentication Method
  • Basic
• SuiteCRM V8 Authentication Methods
  • OAuth Client
  • OAuth Password
• Complete Your Connection
• More Information

You can use the SuiteCRM connector from the CData Sync application to capture data from SuiteCRM and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the SuiteCRM Connector

To enable Sync to use data from SuiteCRM, you first must add the connector, as follows:

1. Open the Connections page of the Sync dashboard.

2. Click Add Connection to open the Select Connectors page.

3. Click the Sources tab and locate the SuiteCRM row.

4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the SuiteCRM connector. For more information about installing new connectors, see Connections.

Authenticate to SuiteCRM

After you add the connector, you need to set the required properties.

• Connection Name - Enter a connection name of your choice.

• URL - Enter the URL for your SuiteCRM account (for example, http://YourSuiteCRMInstance.com.).

SuiteCRMsupports two API schema types. Select your schema below to proceed to the relevant section for your schema.

• SuiteCRM V4.1 API (default)
• SuiteCRM V8 API

SuiteCRM V4.1 API

To connect to SuiteCRM with the SuiteCRM V4.1 API, specify the following properties:

• Schema - Select suitecrmv4.

• Auth Scheme - The only available authentication (auth) scheme for the suitecrmv4 schema is Basic.

SuiteCRM V8 API

To connect to SuiteCRM with the SuiteCRM V8 API, specify the following properties:

• Schema - Select suitecrmv8.

• OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

• OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

• Auth Scheme - Select the authentication method that you want to use to connect to SuiteCRM.

  • OAuth Client (default)
  • OAuth Password

SuiteCRM V4.1 Authentication Method

Basic

To connect with your user credentials, set the following properties:

• Auth Scheme - Select Basic.

• User - Enter the username that you use to authenticate to your SuiteCRM account.

• Password - Enter the password that you use to authenticate to your SuiteCRM account.

SuiteCRM V8 Authentication Methods

OAuth Client

To connect with OAuth client credentials, select OAuthClient for Auth Scheme. No additional properties are required.

OAuth Password

To connect with your user credentials, specify the following properties:

• Auth Scheme: Select OAuthPassword.

• User: Enter the username that you use to authenticate to your SuiteCRM account.

• Password: Enter the password that you use to authenticate to your SuiteCRM account.

Complete Your Connection

To complete your connection:

1. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

2. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and SuiteCRM, see SuiteCRM Connector for CData Sync.