Axios と CData Connect AI で Paylocity に接続した Web アプリを構築

Jerod Johnson
Senior Technology Evangelist

CData Connect AI を使用してライブPaylocity のデータに接続し、Axios で Paylocity に接続した Web アプリを構築します。

Axios は開発者が Web ブラウザや Node.js からサーバーに HTTP リクエストを送信できる JavaScript ライブラリです。CData Connect AI と組み合わせることで、Web アプリからライブPaylocity のデータにアクセスできます。この記事では、Paylocity に接続し、Axios でライブPaylocity のデータにアクセスできる Web アプリを構築する方法を説明します。

Axios から Paylocity に接続

Axios で Paylocity を操作するには、Connect AI から Paylocity に接続し、ユーザーにアクセス権を提供し、Paylocity のデータ用のワークスペースを作成する必要があります。

Connect AI から Paylocity に接続

CData Connect AI はシンプルなポイントアンドクリックインターフェースでデータソースに接続できます。

Connect AI にログインして「Sources」をクリック、次に「 Add Connection」をクリック

接続を追加パネルから「Paylocity」を選択

Paylocity に接続するために必要な認証プロパティを入力します。
Paylocity への接続を確立するには以下を設定します。
- RSAPublicKey：Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。
  このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。
- UseSandbox：サンドボックスアカウントを使用する場合はTrue に設定。
- CustomFieldsCategory：Customfields カテゴリに設定。これは、IncludeCustomFields がtrue に設定されている場合は必須です。デフォルト値はPayrollAndHR です。
- Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。これはコンテンツを暗号化するためのキーです。
  Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
  これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。
- IV：コンテンツを暗号化するときに使用するAES IV（base 64 エンコード）。これはオプションのプロパティで、Key の値が指定されていない場合、ドライバーは内部でIV を生成します。
OAuth

OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。
Pay Entry API

Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。
UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。
「Save & Test」をクリック
Paylocity 接続の追加ページで「Permissions」タブに移動し、ユーザーベースのアクセス許可を設定します。

Personal Access Token の作成

REST API、OData API、または Virtual SQL Server を介して Connect AI に接続する場合、Personal Access Token（PAT）を使用して Connect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別の PAT を作成することをお勧めします。

Connect AI アプリの右上にある歯車アイコン（）をクリックして設定ページを開きます。
設定ページで「Access Tokens」セクションに移動し、「 Create PAT」をクリックします。
PAT に名前を付けて「Create」をクリックします。
Personal Access Token は作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。

Axios 用に Paylocity エンドポイントを設定

Paylocity に接続したら、目的のテーブル用のワークスペースを作成します。

「Workspaces」ページに移動し、「 Add」をクリックして新しいワークスペースを作成します（または既存のワークスペースを選択）。
「 Add」をクリックしてワークスペースに新しいアセットを追加します。
Paylocity 接続（例: Paylocity1）を選択して「Next」をクリックします。
操作するテーブルを選択して「Confirm」をクリックします。
ワークスペースの OData サービス URL をメモしておきます（例: https://cloud.cdata.com/api/odata/{workspace_name}）。

接続、PAT、ワークスペースが設定できたので、Axios からPaylocity のデータに接続する準備が整いました。

Axios ワークフローで Paylocity のデータに接続

OData プロトコルを使用して Axios から CData Connect AI への接続を確立するには、以下のステップに従います。

Web アプリ用のプロジェクトディレクトリを作成します（例: ~/connect_cloud/）
ターミナルを開き、プロジェクトディレクトリに移動して以下のコマンドで node プロジェクトを初期化します:
```
npm init -y
```
以下のコマンドでプロジェクトに Axios 依存関係をインストールします:
```
npm install axios
```

プロジェクトディレクトリに以下のコードを含む server.js ファイルを作成します。CData Connect AI のユーザー名（例: [email protected]）と PAT（前提条件で作成した PAT）を指定します。また、SELECT * FROM Paylocity1.SCHEMA.Employee のようなデータクエリも指定する必要があります。

server.js コード

      const axios = require('axios')

      const user = '[email protected]'
      const pat = '***********************************';

      //API エンドポイント
      const url = 'https://cloud.cdata.com/api/odata/{workspace_name}';

      //POST リクエストで送信するデータ
      const data = {
      "query":"SELECT * FROM {workspace_name}.SCHEMA.Employee"
      };

      axios.post(url, data, {
      auth: {
      username: user,
      password: pat
      }
      })
      .then(response => {
      const rows = response.data.results[0].rows;
      const schema = response.data.results[0].schema;

      //カラム名の配列を作成
      const columnNames = schema.map(col => col.columnName);

      //各行をループして、カラム名と値をログ出力
      rows.forEach(row => {
      const rowObject = {};
      row.forEach((value, index) => {
      const columnName = columnNames[index];
      rowObject[columnName] = value;
      });
      console.log(rowObject);
      })
      })
      .catch(error => {
      console.error('Error:', error);
      });

ターミナルで以下のコマンドを実行してサーバーを起動します:

node server.js

クエリ結果が表示されます:

    { ID: 1, VALUE: -2 }
    { ID: 2, VALUE: 1 }
    { ID: 11, VALUE: null }
    { ID: 3, VALUE: 2 }
    { ID: 4, VALUE: 5 }
    ...

クラウドアプリケーションから Paylocity のデータへの簡易アクセス

これで、Axios からライブPaylocity のデータへの直接接続が確立されました。Axios のようなクラウドアプリケーションから 100 以上の SaaS、ビッグデータ、NoSQL ソースへの簡易アクセスについての詳細は、Connect AI ページを参照してください。

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアルお問い合わせ

Axios と CData Connect AI で Paylocity に接続した Web アプリを構築

Axios から Paylocity に接続

Connect AI から Paylocity に接続

OAuth

Pay Entry API