Install the Java SDK

You can integrate the Java SDK into virtually any Java developer environment. This page describes how to integrate the SDK with Eclipse or any IDE that supports Java.

Requirements

Note

QuickBooks Online apps must use TLS 1.1 or higher to align with industry best practices for security and data integrity. Beginning March 31, 2018, the required version will be TLS 1.2 or higher.

JAR Files

The following JAR files are installed with the Java SDK:

ipp-v3-java-data.jarContains all entities and entity dependencies used in data services operations.
ipp-v3-java-devkit.jarCore component that provides REST API support.
oauth2-platform-api.jarContains the platform API code that supports OAuth 2.0 functions and the refresh/revoke API.
ipp-java-qbapihelper.jarContains the platform API code that supports OAuth 1.0 functions and the reconnect/disconnect API.

Installing the SDK

The following are two ways to integrate the Java SDK into your developer environment:

  • Simple installation with any Java IDE
  • Eclipse installation

Simple Installation with any Java IDE

You can easily install the Java SDK into any Java development environment. To install the Java SDK:

  1. Set the JAVA_HOME variable to point to the directory where the JDK is located and add JAVA_HOME/bin to the PATH variable.
  2. For a Maven project, add the following dependencies to the pom.xml file:
    <!-- data jar -->
    <dependency>
        <groupId>com.intuit.quickbooks-online</groupId>
        <artifactId>ipp-v3-java-data</artifactId>
        <version>2.9.0</version>
    </dependency>
    
    <!-- devkit jar without dependencies-->
    <dependency>
        <groupId>com.intuit.quickbooks-online</groupId>
        <artifactId>ipp-v3-java-devkit</artifactId>
        <version>2.9.0</version>
    </dependency>
  3. For a Gradle project, add the following dependencies to the build.gradle file:
    compile("com.intuit.quickbooks-online:ipp-v3-java-data:2.9.0")
    compile("com.intuit.quickbooks-online:ipp-v3-java-devkit:2.9.0")

Eclipse installation

Eclipse installation allows you to take advantage of Buildship Gradle or Apache Maven integration for enhanced build and project management features. To install the Java SDK and the Gradle and Maven plugins:

  1. Set the JAVA_HOME variable to point to the directory where the JDK is located and add JAVA_HOME/bin to the PATH variable.
  2. Download Eclipse.
  3. Add either or both of the Gradle and Maven plugins:                                                                   
    • To install the Gradle plugin: Go to Help > Eclipse Marketplace... In the Find text box of the Eclipse Marketplace window, type "buildship", select Buildship Gradle Integration 1.0, and click Install.                              
    • To install Maven: Go to Help > Eclipse Marketplace... In the Find text box of the Eclipse Marketplace window, type "maven", select Maven Integration for Eclipse, and click Install.
  4. Download the Java SDK and include it in your project's dependency.
  5. For a Maven project, add the following dependencies to the pom.xml file:
    <!-- data jar -->
    <dependency>
        <groupId>com.intuit.quickbooks-online</groupId>
        <artifactId>ipp-v3-java-data</artifactId>
        <version>2.9.0</version>
    </dependency>
    
    <!-- devkit jar without dependencies-->
    <dependency>
        <groupId>com.intuit.quickbooks-online</groupId>
        <artifactId>ipp-v3-java-devkit</artifactId>
        <version>2.9.0</version>
    </dependency>
  6. For a Gradle project, add the following dependencies to the build.gradle file:
    compile("com.intuit.quickbooks-online:ipp-v3-java-data:2.9.0")
    compile("com.intuit.quickbooks-online:ipp-v3-java-devkit:2.9.0")

After installation

After installation, you will need to configure the SDK. See Quick start for specific instructions on configuration and the development process.

 


Did you find this page helpful?
Your feedback helps us make our docs better. Please let us know if this page helped you, or if it needs improvement.

 Got Questions? Get Answers in our developer forums.