Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for SuiteCRM consists of three basic steps:

Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
Provide the driver class. For example:
```
cdata.jdbc.suitecrm.SuiteCRMDriver
```
Provide the JDBC URL. For example:
```
jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;

or

jdbc:cdata:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;
```
The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:suitecrm:" or "jdbc:cdata:suitecrm:" and can include any of the connection properties in name-value pairs separated with semicolons.

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.