カスタムAPI呼び出し

このピースでできること

  • LINE WORKS APIに対して、任意のHTTPリクエスト(GET/POST/PUT/DELETE/PATCH)を送信します。
  • 認証に必要なヘッダーは自動で付与されます。
 

LINE WORKS の接続方法

OAuth2 で認証します。事前に LINE WORKS Developer Console でアプリと Bot を作成する必要があります。

事前準備 1:アプリの作成

  1. LINE WORKS Developer Console にアクセスします
  1. 「アプリの追加」 をクリックし、アプリを作成します
  1. クライアントIDクライアントシークレット をコピーします
  1. 接続画面に表示されている リダイレクト URL をアプリの設定に登録します

事前準備 2:Bot の作成(メッセージ送信を使う場合)

メッセージ送信・ファイル送信機能を利用する場合は Bot の作成が必要です。
  1. Bot の作成手順 を参照して Bot を作成します

スコープの設定

利用する機能に応じて、スペース区切りでスコープを入力します。
  • bot — メッセージ送信・Bot 機能(デフォルト)
  • user.read — ユーザー情報の読み取り
複数指定する場合はスペースで区切ります(例: )。

接続手順

  1. 接続画面で クライアントIDクライアントシークレットスコープ を入力します
  1. 「接続」 をクリックします
  1. LINE WORKS のログイン画面が表示されるので、アカウントでログインします
  1. アクセス許可を確認して 「許可」 をクリックします
 

ピースの設定項目

1. URL(必須)

  • 呼び出したいAPIのURLを指定します。
[設定例]

2. メソッド(必須)

  • 呼び出しに使用するHTTPメソッドを選択します(GET/POST/PUT/DELETE/PATCH)。
[設定例]

3. ヘッダー(任意)

  • 追加したいリクエストヘッダーをJSON形式で指定します。
  • 認証ヘッダーは自動で注入されるため、通常は指定不要です。
[設定例]

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

  • クエリパラメータをJSON形式で指定します。
[設定例]

5. ボディ(任意)

  • リクエストボディをJSON、またはテキストとして指定します。
[設定例]

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

  • 有効にすると、APIエラーが発生してもフローを失敗にせず、後続の処理を継続します。
[設定例]