Consume Procore OData Feeds in PowerBuilder



This article demonstrates how to consume Procore data as OData feeds from PowerBuilder using the API Server.

The CData API Server, when paired with the ADO.NET Provider for Procore (or any of 200+ other ADO.NET Providers), produces secure feeds of Procore data that you can consume in PowerBuilder DataWindows. The API Server supports the major Web services, including OData, Atom, JSON, HTML, CSV, TSV, and RSS. It also supports the major authentication schemes and SSL.

This article shows how to create a DataWindow that uses the CData API Server to retrieve data.

Set Up the API Server

Follow the steps below to begin producing secure Procore OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Procore

After you deploy the API Server and the ADO.NET Provider for Procore, provide authentication values and other connection properties needed to connect to Procore by clicking Settings -> Connections and adding a new connection in the API Server administration console.

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

You can then choose the Procore entities you want to allow the API Server access to by clicking Settings -> Resources.

Additionally, click Settings -> Server and change the following settings for compatibility with PowerBuilder:

  • Default Format: Select XML (Atom) in the menu.
  • Default Version: Select 2.0 in the menu.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Create a Profile for Procore

Follow the steps below to use the Database Painter tool to create a database profile for the OData API of the API Server. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Click Tools -> Database Painter.
  2. Right-click the OData node and click New Profile.
  3. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • URI: Enter the URL to the OData endpoint of the API Server. This URL will resemble the one below: http://MyServer:8032/api.rsc
    • Supply User Id and Password: Click this option to use HTTP Basic authentication. Note that the API Server also supports Windows authentication.
    • User Id: Enter the name of an user in the API Server.
    • Password: Enter the authtoken of an user in the API Server.
  4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Procore Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to OData feeds and execute queries. The following example shows how to retrieve Procore data into a DataWindow.

You can add the following code to the open method:

SQLCA.DBMS = "ODT" SQLCA.DBParm = "ConnectString='URI=http://MyServer:8032/api.rsc;UID=MyAPIUser;PWD=MyAuthtoken'"; CONNECT USING SQLCA; dw_companies.SetTransObject(SQLCA); dw_companies.Retrieve();

Ready to get started?

Learn more or sign up for a free trial:

CData API Server