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 from PowerBuilder


This article demonstrates how to use the CData ODBC Driver for BambooHR to connect to BambooHR data and execute queries in PowerBuilder.

The CData ODBC Driver for BambooHR can be used from any platform or development technology that supports ODBC, including PowerBuilder. This article shows how to connect to BambooHR data and execute queries from the Database Painter and controls such as the DataWindow.

Connect to BambooHR as an ODBC Data Source

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.

Create a Profile for the ODBC Driver for BambooHR

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for BambooHR. In the Database Painter, you can use wizards and the UI to work with BambooHR data.

  1. In PowerBuilder, click Tools -> Database Painter.
  2. In the Objects window in the Database Painter, right-click the ODBC node and click New Profile.
  3. On the Connection tab, enter a name for the profile and select the BambooHR DSN in the Data Source menu.
  4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using BambooHR Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to ODBC data sources and execute queries. The following example shows how to retrieve BambooHR data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "ODBC" SQLCA.DBParm = "ConnectString='DSN=CData API Source'" CONNECT USING SQLCA; dw_employees.SetTransObject(SQLCA); dw_employees.Retrieve();