SuiteCRM Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium SuiteCRM connector.

This topic describes how to authenticate to SuiteCRM and configure any necessary connection properties in the SuiteCRM connection connector.

Connection Configuration #

Each connection property available in the SuiteCRM connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Schema #

The schema which will be used to connect to SuiteCRM.

Set this to Suite CRMv8 if you want to consume the new Suite CRMv8 API.

The v8 API needs to be configured in your instance of SuiteCRM before it can be used.

Auth Scheme #

The type of authentication to use when connecting to SuiteCRM.

Possible Values

• Basic: Set to this for Basic authentication with user and password. Only available for the suitecrmv4 Schema.

• OAuth Client: Set to this to perform OAuth authentication with the client credentials grant type. Only available for the Suite CRMv8 Schema.

• OAuth Password: Set to this to perform OAuth authentication with the password grant type. Only available for the Suite CRMv8 Schema.

Basic #

If Basic is selected, additional configuration parameters will get listed.

User Name #

The SuiteCRM user account used to authenticate.

Password #

The password used to authenticate the user.

OAuth Client #

If OAuth Client is selected, additional configuration parameters will get listed.

Client ID #

The client Id assigned when you register your application with an OAuth authorization server.

Client Secret #

The client secret assigned when you register your application with an OAuth authorization server.

Refresh Token #

The OAuth refresh token for the corresponding OAuth access token.

OAuth Password #

If OAuth Password is selected, additional configuration parameters will get listed.

Client ID #

The client Id assigned when you register your application with an OAuth authorization server.

Client Secret #

The client secret assigned when you register your application with an OAuth authorization server.

Refresh Token #

The OAuth refresh token for the corresponding OAuth access token.

URL #

The URL of the SuiteCRM account in the form ‘http://{suite crm instance}.com’.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.