はじめに
Workatoでアプリケーションと連携する際、アプリケーションのコネクタ上に使いたいAPIエンドポイント(メソッド)に対応するアクションが提供されていない場合があります。
このような場合は、カスタムアクションを利用することで、任意のAPIエンドポイントに対するリクエストに対応したアクションを実装することが出来ます。
カスタムアクションを利用するメリット
カスタムアクションでは、任意のエンドポイント(メソッド)に対するAPIリクエスト(HTTPリクエスト)に必要なパラメータを設定し、そのパラメータをもとにAPIリクエストを行うことができます。
この機能はHTTPコネクタと同様ですが、コネクション設定時に接続した際の認証情報が使用される(使用できる) 点で大きな違いがあります。
このため、レシピ開発者(レシピビルダー)はアプリケーションの認証処理のことを考えることなく、簡単に任意のエンドポイントに対するAPIリクエストを行うことができます。
例えば、アプリケーションのAPIトークンをカスタムアクションのために個別に取得して設定する、あるいはOAuthクライアント設定をアプリケーション側で行いOAuth2認証を行う、アプリケーション独自の認証フローに対応した実装を行うなど、認証に係る対応をレシピ開発者(レシピビルダー)側で別途行う必要はありません。
手順
今回は、Jiraコネクタと、Jira Data Center REST APIの「Add worklog」エンドポイントを例に、手順の説明を進めていきます。
https://docs.atlassian.com/software/jira/docs/api/REST/7.3.3/#api/2/issue-addWorklog
1.コネクタを追加し、「Custom action」をクリックします。
2.「setup manually」をクリックします。
3.ドキュメントを参考に、メソッドを選択します。
4.ドキュメントを参考に、パスを指定します。
5.ドキュメントに記載のパラメータのサンプル(EXAMPLE等)を利用して、次の手順で入力スキーマを生成します。
6.入力スキーマが生成されたことを確認し、各フィールドへ値またはデータピルをセットします。
7.手順5と同様に、出力スキーマを生成します。
8.出力スキーマが生成されたことを確認します。
出力スキーマに追加されたフィールドは、後続のアクションで使用することが可能です。
参考情報