Consume Talkdesk OData Feeds in PowerBuilder

The CData API Server produces secure feeds of Talkdesk 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 Talkdesk 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 Talkdesk

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

Talkdesk uses the OAuth 2.0 Client Credentials grant. There is no browser-based authorization step and no callback URL.

Set the following connection properties:

• AccountName: The name of your Talkdesk account.
• Region: The region where your Talkdesk instance is deployed. Supported values are US (default), EU, CA, AU, UK, and FedRamp.
• OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The Client Secret assigned to your custom OAuth application.

Creating a Custom OAuth Application

1. Log in to your Talkdesk account and select OAuth Clients from the navigation menu.
2. Click Create OAuth Client and give the client a descriptive name.
3. Set Grant Type to Client Credentials.
4. Click Add scopes and select the scopes for the data you want to access.
5. Click Create and copy the Client Id and Client Secret.

When you connect, the driver automatically requests an access token from Talkdesk, caches it, and refreshes it when it expires. Make sure the scopes selected for the application match the views you plan to query, or the token request can fail.

You can then choose the Talkdesk 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 Talkdesk

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:8080/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 Talkdesk 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 Talkdesk data into a DataWindow.

You can add the following code to the open method:

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