Learn more
 

Ready to get started?

Connect to live data from BambooHR with the API Driver

Connect to BambooHR

In this article

Related articles

Using the CData ODBC Driver for BambooHR in PyCharm


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

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 BambooHR 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 BambooHR 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 BambooHR

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 BambooHR Profile on disk (e.g. C:\profiles\bamboohr.apip). Next, set the ProfileSettings connection property to the connection string for BambooHR (see below).

BambooHR API Profile Settings

In order to authenticate to BambooHR, you'll need to provide your API Key. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient permissions, there will be an "API Keys" option in that menu to go to the page, where you can create a new API Key. Additionally, you will need to set the Domain, found in the domain name of your BambooHR account. For example if your BambooHR account is acmeinc.bamboohr.com, then the Domain should be 'acmeinc'. Set both the API Key and Domain in the ProfileSettings property to connect.

Below is the syntax for a DSN:

[CData API Source] Driver = CData ODBC Driver for BambooHR Description = My Description Profile = C:\profiles\BambooHR.apip ProfileSettings = 'Domain = acmeinc APIKey = your_api_key'

Execute SQL to BambooHR

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\BambooHR.apip;ProfileSettings = 'Domain = acmeinc;APIKey = your_api_key';') cursor = cnxn.cursor() cursor.execute("SELECT Id, DisplayName FROM Employees WHERE Department = 'Sales'") rows = cursor.fetchall() for row in rows: print(row.Id, row.DisplayName)

After connecting to BambooHR in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to BambooHR 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.