外部 API の実行に必要な情報を取得する

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

関数

PC／モバイル

kintone.plugin.app.getProxyConfig(url, method)

引数

戻り値

外部 API の実行に必要な情報が、キーと値を対にしたオブジェクトの形式で返ります。

null になる条件

• 利用できない画面
• プラグインから外部 API を実行する API で設定した設定情報と、一致する設定情報がない場合

利用できる画面

• プラグインごとの設定画面

サンプルコード

この API を使って、 外部 API の実行に必要な情報をプラグインへ保存する API で保存した値を取得する例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

const headers = {
  Authorization: 'Bearer TEST_TOKEN',
};
const data = {
  key1: '1',
  key2: true
};
kintone.plugin.app.setProxyConfig('https://api.example.com', 'POST', headers, data);
const config = kintone.plugin.app.getProxyConfig('https://api.example.com', 'POST');
console.log(config);

注意事項

• この API を使って、 外部 API の実行に必要な情報をプラグインへ保存する API で header に指定した値を取得する場合、必ず値は文字列になります。
  たとえば、 外部 API の実行に必要な情報をプラグインへ保存する API を使って、headers に数値型や真偽値型の値を設定したとします。

  1 2 3 4 5

  const headers = { key1: 1, // 数値 key2: true, // 真偽値 }; kintone.plugin.app.setProxyConfig('https://api.example.com', 'POST', headers, {}, () => console.log('Saved!'));

  このとき、 外部 API の実行に必要な情報を取得する API を実行すると、数値型や真偽値型の値は、文字列型で返ります。

  1 2 3 4 5 6 7 8 9 10 11 12

  const config = kintone.plugin.app.getProxyConfig('https://api.example.com', 'POST'); console.log(config); /** * 1 と true は文字列型になる * { * headers: { * "key1": "1", // 文字列 * "key2": "true", // 文字列 * }, * data: {}, * } **/