外部 API の実行に必要な情報をプラグインへ保存する

外部の 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" } です。