ODBC Driver for SuiteCRM

Build 22.0.8462

Windows DSN Configuration

Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

  1. Select Start > Search, and enter ODBC Data Sources in the Search box.
  2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
  3. Click the System DSN tab.
  4. Select the system data source and click Configure.
  5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

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.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462