PowerBuilder で Xero OData フィードを利用
CData API Server は、PowerBuilder DataWindow で利用できるセキュアなXero のデータフィードを生成します。API Server は、OData、Atom、JSON、HTML、CSV、TSV、RSS などの主要な Web サービスをサポートしています。また、主要な認証スキームと SSL もサポートしています。
この記事では、CData API Server を使用して読み取りと書き込みを実行する DataWindow を作成する方法を説明します。
Xero データ連携について
CData を使用すれば、Xero のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています:
- Xero Accounts と、米国およびオーストラリアの Payroll API の両方に接続できます。
- Customers、Transactions、Invoices、Sales Receipts などの Xero オブジェクトの読み取り、書き込み、更新、削除ができます。
- SQL ストアドプロシージャを使用して、カートへのアイテム追加、注文の送信、添付ファイルのダウンロードなどのアクションを実行できます。
- 会計、給与、ファイル、固定資産、プロジェクトデータを扱うことができます。
お客様は、Tableau、Qlik Sense、Excel などのお気に入りのツールと Xero データを定期的に統合し、Xero データをデータベースやデータウェアハウスに統合しています。
はじめに
API Server のセットアップ
以下の手順に従って、セキュアな Xero OData サービスの作成を開始します。
デプロイ
API Server は独自のサーバー上で実行されます。Windows では、スタンドアロンサーバーまたは IIS を使用してデプロイできます。Java サーブレットコンテナでは、API Server WAR ファイルをドロップします。詳細と手順については、ヘルプドキュメントを参照してください。
API Server は、Microsoft Azure、Amazon EC2、Heroku へのデプロイも簡単です。
Xero への接続
API Server をデプロイしたら、API Server 管理コンソールで Settings -> Connections をクリックして新しい接続を追加し、Xero に接続するために必要な認証値やその他の接続プロパティを指定します。
接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。
パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。
Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。
次に、Settings -> Resources をクリックして、API Server からアクセスを許可する Xero エンティティを選択できます。
また、Settings -> Server をクリックし、PowerBuilder との互換性のために以下の設定を変更します:
- Default Format:メニューから XML (Atom) を選択。
- Default Version:メニューから 2.0 を選択。
API Server ユーザーの認可
生成する OData サービスを決定したら、Settings -> Users をクリックしてユーザーを認可します。API Server は Authtoken ベースの認証を使用し、主要な認証スキームをサポートしています。アクセスは IP アドレスに基づいて制限することもできます。デフォルトでは、ローカルマシンへの接続のみが許可されています。SSL で認証と接続の暗号化も可能です。
Xero 用のプロファイルを作成
以下の手順に従って、Database Painter ツールを使用して API Server の OData API 用のデータベースプロファイルを作成します。Database Painter では、データをグラフィカルに操作したり、SQL クエリを実行したりできます。
- Tools -> Database Painter をクリックします。
- OData ノードを右クリックし、New Profile をクリックします。
- Database Profile Setup ダイアログで、以下を入力します:
- Profile Name:プロファイルのわかりやすい名前を入力します。
- URI:API Server の OData エンドポイントへの URL を入力します。この URL は以下のような形式になります:
http://MyServer:8080/api.rsc
- Supply User Id and Password:HTTP Basic 認証を使用する場合は、このオプションをクリックします。なお、API Server は Windows 認証もサポートしています。
- User Id:API Server のユーザー名を入力します。
- Password:API Server のユーザーの Authtoken を入力します。
- テーブルを表示・変更するには、テーブルを右クリックして Edit Data -> Grid をクリックします。
PowerBuilder コントロールで Xero のデータ を使用
標準的な PowerBuilder オブジェクトを使用して OData フィードに接続し、クエリを実行できます。以下の例は、Xero のデータ を DataWindow に取得する方法を示しています。
open メソッドに以下のコードを追加できます:
SQLCA.DBMS = "ODT" SQLCA.DBParm = "ConnectString='URI=http://MyServer:8080/api.rsc;UID=MyAPIUser;PWD=MyAuthtoken'"; CONNECT USING SQLCA; dw_items.SetTransObject(SQLCA); dw_items.Retrieve();