httpHelperフローを構築する

httpHelperフローは、コネクタービルダーで構築される各アクションカードの認証と任意のHTTPリクエストを管理します。

これは、パターンの繰り返しを減らすというソフトウェア開発の原則に対応します。

httpHelperフローの作成にはいくつかのタスクが関連します。

次の例は、完全なhttpHelperフローがOkta Workflowsにどのように表示されるかを示します。

はじめに

この共通フローを構築するには、事前に次を行う必要があります。

  • コネクターを作成する。「コネクターの作成」を参照してください。

  • 認証を構築する。「認証」を参照してください。

このタスクを開始する

httpHelperフローを作成する

  1. ［Flows（フロー）］タブで、［+ New Flow（新規フロー）］をクリックしてフローを作成します。

  2. ［Add event（イベントの追加）］をクリックし、［Helper Flow（ヘルパーフロー）］を選択します。

  3. ツールバーの［Save（保存）］をクリックし、フローにhttpHelperという名前を付けます。

  4. チームの他の作成者がフローの目的を理解できるように、フローの説明を追加します。例：This flow manages all authentication and http requests for the connector.（このフローはコネクターのすべての認証とhttpリクエストを管理する）。

  5. ［Save all data that passes through the flow（フローを通過するすべてのデータを保存）］ボックスをチェックして［Save（保存）］をクリックします。

  6. Helper Flowカードに次の入力名とデータタイプを追加します。［Click or drag to create（クリックまたはドラッグして作成）］という領域をクリックし、入力名を追加してEnterキーを押します。次に、フィールド自体に表示されるドロップダウンリストからタイプを選択します。

    • relative_url（テキスト）

    • request_method（テキスト）

    • query（オブジェクト）

    • headers（オブジェクト）

    • body（オブジェクト）

次のタスクは、HTTP呼び出しに適したオブジェクトを作成する一連のカードを構築します。選択するオプションは、使用する必要がある認証タイプによって決まります。

オプション1：OAuth認証の構築

  1. ベアラーとアクセストークンを結合するために、Text Concatenate関数カードを追加します。

  2. ［text 1（テキスト1）］フィールドに「Bearer 」と入力します。連結文字列の一部であるため、空白文字も含めてください。

  3. Helper Flowカードのaccess_token（アクセストークン）フィールドをConcatenateカードのtext 2（テキスト2）フィールドにドラッグします。

  4. フィールドのドロップダウンリストをクリックして［customize（カスタマイズ）］をクリックし、出力フィールドにbearerという名前を付けます。これらのフィールド名の変更はベストプラクティスであり、必須ではありません。

  5. Concatenateカードの後にObject Construct関数カードを追加します。

  6. ［Click or drop here to create（クリックまたはドラッグして作成）］という領域をクリックし、Authorizationというラベルを追加します。

  7. Concatenateカードのbearer（ベアラー）出力フィールドをこのフィールドにドラッグします。

    これにより、すべてのHTTPリクエストで共有される任意の追加ヘッダーを追加できるようになります。例：Content-Type（コンテンツタイプ）、application/json（アプリケーション/JSON）。

  8. フィールドのドロップダウンをクリックして［customize（カスタマイズ）］をクリックし、出力フィールド名をheaderに変更します。

オプション2：基本認証の構築

  1. ユーザー名とパスワードをコロンで区切って結合するためにText Concatenate関数カードを追加します。

  2. Helper FlowカードのusernameフィールドをConcatenateカードのtext 1（テキスト1）入力にドラッグします。

  3. Concatenateカードのtext 2（テキスト2）フィールドに手動でコロン（:）を入力します。

  4. Helper FlowカードのpasswordフィールドをConcatenateカードの［Click or drop here to create（クリックまたはドラッグして作成）］という領域にドラッグします。

  5. Concatenateカードの出力フィールド名をusername_passwordに変更するか、有用な別の名前に変更します。

  6. Text Base64関数カードを追加します。Concatenateカードのusername_password（ユーザー名とパスワード）フィールドをBase64カードのtext（テキスト）入力にドラッグします。

  7. フィールドのドロップダウンをクリックして［customize（カスタマイズ）］をクリックし、Base64カードの出力フィールド名をbase_64に変更します。

  8. フローに別のText Concatenate関数カードを追加します。

  9. ［text 1（テキスト1）］フィールドに「Basic 」と入力します（Basicの後に空白文字を入れます）。

  10. Base64カードのbase_64（base_64）出力を2番目のConcatenateカードのtext 2（テキスト2）フィールドにドラッグします。

  11. 2番目のConcatenateカードの出力フィールド名をauth_valueに変更します。

  12. 2番目のConcatenateカードの後にObject Constructを追加します。

  13. ［Click or drop here to create（クリックまたはドラッグして作成）］という領域をクリックし、Authorizationというラベルを追加します。

  14. 2番目のConcatenateカードのauth_value（auth_value）出力フィールドをこのフィールドにドラッグします。

    これにより、サービスへのすべてのHTTPリクエストで共有される任意の追加ヘッダーを追加できるようになります。例：Content-Type（コンテンツタイプ）、application/json（アプリケーション/JSON）。

  15. フィールドのドロップダウンをクリックして［customize（カスタマイズ）］をクリックし、この出力フィールドの名前をheaderに変更します。

オプション3：カスタム（APIキー）認証の構築

  1. 新規フローにObject Constructカードを追加します。

  2. ［Click or drop here to create（クリックまたはドラッグして作成）］という領域をクリックし、ヘッダーに含めるキーの名前を追加します。たとえば、api_keyのような名前を付けます。

  3. Helper Flowカードのapi_key（APIキー）フィールドをこのフィールドにドラッグします。

    これにより、すべてのHTTPリクエストで共有される任意の追加ヘッダーを追加できるようになります。例：Content-Type（コンテンツタイプ）、application/json（アプリケーション/JSON）。

httpHelperフローを完成させる

  1. フローにObject Mergeカードを追加します。

  2. Construct関数カードのheader（ヘッダー）出力をMergeカードのobject 1（オブジェクト1）フィールドにドラッグします。

  3. Helper Flowカードのheaders（ヘッダー）出力をMergeカードのobject 2（オブジェクト2）フィールドにドラッグします。これにより、必要なエンドポイント固有のヘッダーを渡せるようになります。

  4. Mergeカードの出力フィールド名をmerged_headerに変更します。

  5. フローにText Concatenateカードを追加します。

  6. フローのベースURLを特定のエンドポイントなしで［text 1（テキスト1）］フィールドに入力します（例：https://api.spotify.com/v1）。

  7. Helper Flowカードのrelative_url（関連URL）フィールドをtext 2（テキスト2）フィールドにドラッグします。

  8. このカードの出力フィールド名をfull_url（フルURL）に変更します。

  9. ［API Connector（APIコネクター）］からRaw Requestアクションカードを追加します。

  10. Concatenateカードのfull_url（フルURL）出力フィールドをRaw RequestカードのURL（URL）入力にドラッグします。

  11. Helper Flowカードのrequest_method（要求メソッド）出力フィールドをRaw RequestカードのMethod（メソッド）入力にドラッグします。

  12. Helper Flowカードのquery（クエリ）出力フィールドをRaw RequestカードのQuery（クエリ）入力にドラッグします。

  13. Mergeカードのmerged_header（merged_header）フィールドをRaw RequestカードのHeaders（ヘッダー）入力にドラッグします。

  14. Helper Flowカードのbody（本文）出力フィールドをRaw RequestカードのBody（本文）入力にドラッグします。

  15. ［Click or drop here to create（クリックまたはドラッグして作成）］という領域をクリックし、この3つのフィールドをFlow Control Returnカードに追加します。

    • status_code（数値）

    • headers（Object）

    • body（オブジェクト）

  16. Raw Requestカードの対応する出力を新たに作成したフィールドにドラッグします。

  17. フローを保存し、テストダイアログに相対URL、リクエストメソッド、その他の必要データを手動で追加してテストします。

次の手順

_authpingフローの構築