はじめてのコネクタを構築する

このセクションでは、コネクタ ビルダーを使用してコネクタを作成し、オートメーション内で使用する方法について説明します。コネクタを手動で作成する例を挙げて説明するため、通常はスキップできる手順も記載しています。

「API 定義からコネクタを構築する」もご覧ください。ここで Swagger 定義をインポートし、コネクタ ビルダーでほとんどの作業を実行します。

設計するワークフローは、関心のある株価に関する Slack メッセージを毎日受信することを目的としています。Polygon.io は、株式情報を取得する無料の API セットを提供しており、この目的にも使用できます。Polygon.io で簡単な登録プロセスを経ると、必要な API 呼び出しを行うための API キーが提供されます。

Polygon.io に登録する

ほとんどのベンダー アプリケーションでは、ユーザー名とパスワード、OAuth アプリ、API キーなどの形式で認証の詳細が必要です。Polygon.io も例外ではなく、無料登録をすると一部の API を試すことができます。

1. polygon.io に移動し、アカウントを作成します。
2. ダッシュボードを開き、API キーを選択してキーを表示します。

コネクタ ビルダーでコネクタを作成する

Automation Cloud^TM 内で [Integration Service] に移動し、[コネクタを構築] を選択します。

空のコネクタから始めましょう。手元に何らかの形式の API 定義 (Swagger、YAML など) がある場合は、[API 定義から開始] を選択して、ほとんどの構成作業をコネクタ ビルダーに任せることができます。

Web から polygon.svg アイコンをダウンロードして、ロゴをカタログに追加します。

注: すべての画像の種類がサポートされていますが、正方形の SVG を使用することをお勧めします。

カスタム コネクタの名前と説明を追加し、[作成] を選択します。

認証をセットアップし接続する

Polygon のドキュメントでは、プラットフォームへの API 呼び出しでは、API キーをヘッダーまたはクエリ パラメーターで送信する必要があると説明されています。これを行うには、次の例で説明するように、ヘッダーに追加する必要があります。

1. API キーを以下のようにクエリ文字列で渡します。<your_token> は API キーです。

   https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2023-01-09/2023-01-09?apiKey=<your_token>

2. あるいは、以下の形式で API キーをトークンとして、認可ヘッダーを要求に追加することもできます。ここで、<your_token> は API キーです。

   Authorization: Bearer <your_token>

3. コネクタ ビルダーで、[設定] に移動して [ベース API] タブを選択します。[ベース URL] を https://api.polygon.io に設定します。
   注: この例では、ベース URL に version "v2" セクションを追加しません。追加すると、古いストック API 呼び出しの一部の実行が可能となるからです。
   
   

   

   
   
4. 次に、[認証] タブに移動し、ドロップダウン リストから使用する認証の種類を選択します。この例では、[個人用アクセス トークン (PAT)] を選択します。
   注:

   Polygon のドキュメントでは API キーを参照していますが、Authorization: Bearer <your_token> として送信する必要があることを考えると、実際には OAuth スタイルのトークンに近いものです。したがって、技術的には個人用アクセス トークン (PAT) がより良い定義です。さまざまな認証の種類について詳しくは、こちらをご覧ください。

5. Polygon から API キーをコピーし、[値] を「Bearer <your_key>」に設定します。
6. [ユーザーに確認] フィールドを [いいえ] に設定し、このコネクタへのコネクションを作成するときにユーザーがキーの入力を求められないようにします。これは、テナントを超えてこのコネクタを共有しないためです。ただし、テナントを超えてコネクタを共有する場合は、独自のキーを追加せず、[ユーザーに確認] を [はい] に設定し、他のユーザーによる Polygon サービスへの登録を求められるようにします。

   ほとんどの作業は、コネクタ ビルダーで事前に設定された認証の種類で行われます。たとえば、個人用アクセス トークンは、認証ヘッダーとして Authorization: Bearer <your_token> を自動的に送信します。ユーザーが自分でこの構成を構築する必要はありません。

   
   

   

   
   
7. [未接続] > [コネクションを追加] ボタンを選択して、上記の構成でコネクションを設定します。新しく作成したコネクタは、Integration Service の他のコネクタと同様に動作します。[接続] をクリックして、API 呼び出しを実行するテスト接続を作成します。

API 呼び出しをテストする

サードパーティ ソフトウェアへのコネクションを確立したら、API 呼び出しを実際に実行します。

1. 左側のパネルで [API] > [新しいリソース グループを作成] に移動します。この操作の目的は、特定の株式の始値に関する Slack 通知を毎日受け取ることです。ここで実装するエンドポイントは、Polygon の Daily open/close API です。
   
   

   

   
   
2. [新しいリソース グループを作成] ウィンドウに、Polygon ドキュメントの画面に表示される内容をコピーします。
3. [パス] を「/open-close/{stocksTicker}/{date}」に設定します。
4. [メソッドを選択] リストから [レコードを取得 (GETBYID)] を有効化します。オブジェクトの配列ではなく、単一のオブジェクトを選択するからです。
5. 「Open - Close for stock」などの表示名を指定します。コネクタ ビルダーによって {x} 変数が自動的にパス変数に変換されます。
6. [作成] を選択して、このリソースを追加します。
   
   

   

   
   
   

   

   
   
7. 設定が機能しているかどうかをテストするには、リソースの横にある [要求を送信] ボタンを選択します。これにより、2 つのパス パラメーターの値が作成されます。これらは、Polygon ドキュメントの使用法の例から取得できます。
   
   

   

   
   

コネクタをカタログに公開する

いくつかの追加手順を実行して、リソースとパラメーターの外観と動作を向上させることができます。たとえば、date パラメーターの型が DateTime であることを確認してマスクします。表示名を指定すると、Studio アクティビティ内でのコネクタの表示がよりよくなります。以下のスクリーンショットに例を示します。

最後の手順として、[パブリッシュ] を選択してコネクタをテナントにパブリッシュします。コネクタはテナント内で表示されているコネクタのリストに表示され、同じテナントを使用しているすべてのユーザーが Polygon コネクタを表示および使用できます。

UiPath® Studio でコネクタを使用する

コネクタを Integration Service に表示するのは、そのコネクタをワークフローで実際に使用できる場合にのみ有効です。

ワークフローでカスタム コネクタをテストするには、以下の手順を実行します。

1. UiPath Studio を開いて、新しいプロジェクトを作成します。たとえば、「毎日の株価を Slack で受け取る」プロジェクトです。毎日メッセージを受信するため、このワークフローで使用する最初のアクティビティは [タイム トリガー] です。
   
   

   

   
   
2. 次に、Polygon アクティビティをキャンバスにドラッグすると、自分のアカウントで Polygon.io に接続するよう求められます。
3. コネクションが確立したら、Apple の株 (AAPL) に関する情報を取得するように Polygon アクティビティを設定します。関心のある銘柄をハードコードできますが、日付を実行時の日付に書式設定する必要があります。
4. 次に、この情報をチャンネルに送信するための Slack アクティビティ [チャンネルにメッセージを送信] を追加します。自分宛てに情報を送信する場合は、[ユーザーにメッセージを送信] を使用します。

注: Polygon の API は一度に 1 つの株しか取り込みませんが、コネクタを介して複数の呼び出しを行い、UiPath の 1 日の株式始値 (PATH) も通知するよう Studio を設定できます。

フローは次のようになります。