カスタムAPI呼び出し

このピースでできること

  • PHONE APPLI PEOPLE の任意の API エンドポイントに対してカスタムな HTTP リクエストを実行します。
  • 標準アクションにはない操作を行いたい場合に使用します。
  • 認証ヘッダー(APIキー・サービスコード)は接続から自動で注入されます。

PHONE APPLI PEOPLE の接続方法

workrun と PHONE APPLI PEOPLE を接続するには、PHONE APPLI PEOPLE の API キー が必要です。

ステップ 1:API キーを取得する

  1. PHONE APPLI PEOPLE の PC ブラウザ版にログインする。
  1. 画面右上のユーザー名 →「ユーザー情報」を開く。
  1. 「APIキー」タブを開き、「APIキーを発行」をクリックする。
  1. 必要なスコープを選択する。
      • (「社外連絡先一覧を取得する」アクション・「社外連絡先が登録された時」トリガーで必要)
      • 「カスタムAPI呼び出し」アクションで他リソースを操作する場合は、対応するスコープも追加してください。
  1. 発行された API キーをコピーする。

ステップ 2:workrun に接続を追加する

  1. workrun で PHONE APPLI PEOPLE のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「API Key」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
  1. 「保存」 をクリックして接続を完了します。

ピースの設定項目

1. URL(必須)

  • 呼び出す先の URL を入力します。完全な URL()またはベース URL からの相対パス()のどちらでも指定できます。
  • このアクションの前後に PHONE APPLI PEOPLE のトリガーやアクションがある場合は、Delay アクションなどで 1 秒以上の待機時間を挿むことを推奨します(リクエスト制限によりエラーになる可能性があります)。

2. メソッド(必須)

  • HTTP メソッドを選択します(GET / POST / PUT / PATCH / DELETE)。

3. ヘッダー(任意)

  • 追加ヘッダーをキーと値のペアで指定します。認証ヘッダーは接続から自動で注入されます。

4. クエリパラメータ(任意)

  • URL に付加するクエリパラメータをキーと値のペアで指定します。

5. ボディタイプ(任意)

  • ボディの形式を選択します(なし / JSON / Raw / フォームデータ)。

6. ボディ(任意)

  • リクエストボディを指定します。ボディタイプに応じた形式で入力します。

7. 応答はバイナリですか?(任意)

  • PDF・画像などのファイルを取得する場合はチェックします。

8. 失敗時にエラーにしない(任意)

  • チェックするとリクエスト失敗時もフローを継続します。

9. タイムアウト(秒)(任意)

  • リクエストのタイムアウト時間を秒単位で指定します。