Connect to ConvertAPI Data from PowerBuilder via ODBC

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

Connect to ConvertAPI 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.

ConvertAPI uses API Secret Key authentication. Your ConvertAPI Secret is used to authenticate requests. You can find your API Secret in the ConvertAPI dashboard under your account settings.

Using APIKey Authentication

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your ConvertAPI API secret key.

Example connection string:

Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Create a Profile for the ODBC Driver for ConvertAPI

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for ConvertAPI. In the Database Painter, you can use wizards and the UI to work with ConvertAPI 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 ConvertAPI DSN in the Data Source menu.
4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using ConvertAPI 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 ConvertAPI 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_user.SetTransObject(SQLCA);
dw_user.Retrieve();