Learn more
 

Ready to get started?

Connect to live data from BambooHR with the API Driver

Connect to BambooHR

In this article

Related articles

Connect to BambooHR Data in DBArtisan


Use wizards in DBArtisan to configure BambooHR data as a data source.

The CData ODBC Driver for BambooHR seamlessly integrates BambooHR data into database management tools like DBArtisan by enabling you to access BambooHR data as a database. This article shows how to create an data source for BambooHR in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate BambooHR Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then follow the steps below to register BambooHR data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic ODBC.
  3. Enter a name for the data source and select the DSN.
  4. Finish the wizard to connect to BambooHR data. BambooHR entities are displayed in the Datasource Explorer.

You can now work with BambooHR data as you work with any other database. See the driver help documentation for more information on the queries supported by the BambooHR API.