Learn more
 

Ready to get started?

Connect to live data from Procore with the API Driver

Connect to Procore

In this article

Related articles

Create a Data Access Object for Procore Data using JDBI


A brief overview of creating a SQL Object API for Procore data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Procore integrates connectivity to live Procore data in Java applications. By pairing these technologies, you gain simple, programmatic access to Procore data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Procore data.

Create a DAO for the Procore Companies Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyCompaniesDAO { //request specific data from Procore (String type is used for simplicity) @SqlQuery("SELECT Name FROM Companies WHERE IsActive = :isActive") String findNameByIsActive(@Bind("isActive") String isActive); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Procore

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Procore.

Start by setting the Profile connection property to the location of the Procore Profile on disk (e.g. C:\profiles\Procore.apip). Next, set the ProfileSettings connection property to the connection string for Procore (see below).

Procore API Profile Settings

To authenticate to Procore, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

First, you will need to register an OAuth application with Procore. You can do so by logging to your Developer Account and going to Create New App. Follow all necessary steps to register your app. First you will need to create a new version of Sandbox Manifest and then promote it to Production in order to get your Production Crendentials. Your Oauth application will be assigned a client id and a client secret.

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the client_id that is specified in you app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
  • CallbackURL: Set this to the Redirect URI that is specified in your app settings

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Procore JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Procore will typically look like the following:

jdbc:api:Profile=C:\profiles\Procore.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Procore.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH"); MyCompaniesDAO dao = dbi.open(MyCompaniesDAO.class); //do stuff with the DAO dao.close();

Read Procore Data

With the connection open to Procore, simply call the previously defined method to retrieve data from the Companies entity in Procore.

//disply the result of our 'find' method String name = dao.findNameByIsActive("true"); System.out.println(name);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Procore by integrating with the CData JDBC Driver for Procore. Download a free trial and work with live Procore data in custom Java applications today.