外部のAPIを実行するときに必要な情報を、プラグインに保存します。
このAPIを使って保存された情報は、 プラグインから外部 API を実行する APIを実行したときに、リクエストのヘッダーとボディに追加されます。

認証情報など、秘匿する情報を外部APIの実行で使用する場合は、このAPIを使って必要な情報をあらかじめプラグインに保存します。

このAPIは、アプリの管理者だけがアクセスできるプラグイン設定画面でのみ実行できます。
そのため、アプリの利用者がプラグインへ保存された情報にアクセスすることを防げます。

PC

kintone.plugin.app.setProxyConfig(url, method, headers, data, successCallback)

指定したURLとHTTPメソッドの組み合わせがすでに存在している場合は、プラグインの設定が上書きされます。

{
  "key1": "value1",
  "key2": "value2"
}

なし

PC

• 各プラグインの設定画面

モバイル

なし

保存した情報がリクエストに追加される条件

• プラグインから外部 API を実行する APIを使ったリクエストでは、次の条件をすべて満たすときに、プラグインへ保存した情報がリクエストに追加されます。

  • アプリが同一
  • プラグインが同一
  • HTTPメソッドが同一
  • 実行するAPIのURLが前方一致する ^*1
    URLの大文字と小文字は区別されます。

• プラグインに複数の設定を保存した場合は、APIの実行時に指定したURLと、より多くの文字が一致するURLを指定している設定が優先されます。
  たとえば、このAPIで、次のようなURLやリクエストヘッダーを指定したとします。

  • 設定その1
    • URL：https://api.example.com/
    • ヘッダー：{ "Content-Type": "application/x-www-form-urlencoded" }
  • 設定その2
    • URL：https://api.example.com/foo/
    • ヘッダー：{ "Content-Type": "application/json" }

  次の値を指定して、 プラグインから外部 API を実行する APIを実行します。

  • URL：「https://api.example.com/foo/operate.json」
  • ヘッダー：{}

  このとき、APIの実行時に送信されるリクエストのヘッダーは、{ "Content-Type": "application/json" }です。