Learn more
 

Ready to get started?

Connect to live data from Procore with the API Driver

Connect to Procore

In this article

Related articles

Using the CData ODBC Driver for Procore in PyCharm


Connect to Procore as an ODBC data source in PyCharm using the CData ODBC Driver for Procore.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Procore from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Procore as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to Procore

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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

Below is the syntax for a DSN:

[CData API Source] Driver = CData ODBC Driver for Procore Description = My Description Profile = C:\profiles\Procore.apip Authscheme = OAuth OAuthClientId = your_client_id OAuthClientSecret = your_client_secret CallbackUrl = your_callback_url

Execute SQL to Procore

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\Procore.apip;Authscheme = OAuth;OAuthClientId = your_client_id;OAuthClientSecret = your_client_secret;CallbackUrl = your_callback_url;') cursor = cnxn.cursor() cursor.execute("SELECT Id, Name FROM Companies WHERE IsActive = 'true'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Name)

After connecting to Procore in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Procore data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.