> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuiteCRM

export const title_2 = "SuiteCRM";

export const title_1 = "SuiteCRM";

export const title_0 = "SuiteCRM";

## Prerequisites

The SuiteCRM V8 API uses OAuth for authentication, so the **OAuthClient** and **OAuthPassword** authentication methods require a custom OAuth application. If you are connecting to the SuiteCRM V4.1 API with the **Basic** authentication method, you can skip this section.

A SuiteCRM administrator must create and register the custom OAuth application. To create a custom OAuth application in SuiteCRM, follow these steps:

<Steps>
  <Step>
    Log in to your SuiteCRM account with administrative credentials.
  </Step>

  <Step>
    In the **Profile** dropdown, select **Admin > OAuth2 Clients and Tokens**.
  </Step>

  <Step>
    Click **New Client Credentials Client** (for the **OAuthClient** method) or **New Password Client** (for the **OAuthPassword** method).
  </Step>

  <Step>
    Enter a **Name** and a **Secret** for the application, then click **Save**.
  </Step>

  <Step>
    Retrieve the generated client ID and client secret. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>
</Steps>

<Note>
  Users who authenticate with the **OAuthClient** (client credentials) grant type have full access to the API. Users who authenticate with the **OAuthPassword** grant type require permissions for each module or table they access.
</Note>

## Setup Guide

Follow these steps to connect SuiteCRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SuiteCRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of your SuiteCRM account, for example *[http://your-suitecrm-instance.com](http://your-suitecrm-instance.com)*.
  </Step>

  <Step>
    Select the **Schema** that matches your SuiteCRM API version: **suitecrmv4** for the SuiteCRM V4.1 API or **suitecrmv8** for the SuiteCRM V8 API.
  </Step>

  <Step>
    Select the **Auth Scheme** to use when connecting to SuiteCRM, then follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Confirm that the **Schema** is set to **suitecrmv4**. The **Basic** authentication method is supported only for the SuiteCRM V4.1 API.
      </Step>

      <Step>
        Enter the **User**, the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password** for that user.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_0} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Confirm that the **Schema** is set to **suitecrmv8**. The **OAuthClient** authentication method is supported only for the SuiteCRM V8 API.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Confirm that the **Schema** is set to **suitecrmv8**. The **OAuthPassword** authentication method is supported only for the SuiteCRM V8 API.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **User**, the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password** for that user.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_2} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SuiteCRM, see [this information page](https://cdn.cdata.com/help/ETM/cloud/default.htm#default).