SuiteCRM Advanced Settings

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. To authenticate to SuiteCRM V8 API, please do the following. Note that you have to be an admin to create credentials, create roles, assign roles to users etc.

Note: The OAuth flow is the same in a headless machine.

Register an Application

To obtain the OAuth client credentials, the consumer key, and consumer secret:

1. Log in to your admin account.
2. On profile dropdown select Admin > OAuth2 Clients and Tokens and click New Password Client or New Client Credentials Client.
3. Enter a name and a secret.
4. Click Save.

Assign Roles for API Access

 Usually when authenticating with a client credentials grant type, you will have full access to the API. For authentication with password grant type, the user should have permissions for each module/table.

Users' access to certain resources can be set by configuring REST roles and assigning users to the specific REST roles.

To create a role:

1. On the profile dropdown, select Admin > Role Management and click Create Role.
2. Enter name and description and click Save. Then, you will be redirected to the role configuration menu where you can select permissions to any operation on any module.
3. After you are done with setting up the permissions, you can click Save.

 To assign a role to a user:

1. On profile dropdown, select Admin > Role Management and click on the role you want to assign to a user.
2. Scroll down to the bottom and click Select User.
3. A user search window will appear.
4. Select the users you want to assign the role to and click Select > Save.

Authenticating using Client Credentials Grant

 After setting the following connection properties, you are ready to connect:

• Schema: Set this to the suitecrmv8.
• OAuthGrantType: Set this to CLIENT.
• OAuthClientId: Set this to the client key that you received.
• OAuthClientSecret: Set this to the client secret that you noted.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
• URL: The base URL of your SuiteCRM system. For example, https://suitecrmhost/.

Authenticating using Password Grant

After setting the following connection properties, you are ready to connect:

• Schema: Set this to the suitecrmv8.
• OAuthGrantType: Set this to PASSWORD.
• OAuthClientId: Set this to the client key that you received.
• OAuthClientSecret: Set this to the client secret that you noted.
• User: Set this to the username associated with the user.
• Password: Set this to the password associated with the user.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
• URL: The base URL of your SuiteCRM system. For example, https://suitecrmhost/.

Customizing the SSL Configuration