將執行外部API所需的資訊儲存在外掛程式。
在執行以下API時，使用此API儲存的資訊將添加到請求的標頭和正文中。
從外掛程式執行外部API

如果要在執行外部API時使用保密資訊（例如身份驗證資訊），請事先使用此API將所需資訊存儲在外掛程式中。

只能在外掛程式設置畫面上執行，只有應用程式的管理員才能訪問該畫面。
這樣可以防止應用程式的使用者存取外掛程式中儲存的資訊。

此API是異步API。
如果要同步處理，請參閱以下頁面。

• JavaScript入門：Promise和async/await （日語）
• kintone API入門：在kintone自訂里使用異步處理 （日語）

電腦版

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

如果指定的URL和HTTP方法組合已存在，它將覆蓋外掛程式設置。

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

無

電腦版

• 外掛程式的設定畫面

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

await new Promise((resolve) => {
  kintone.plugin.app.setProxyConfig(
    'https://api.example.com',
    'POST',
    {},
    {},
    () => {
      resolve();
    }
  );
});

將儲存的資訊添加到請求的條件

• 使用從外掛程式執行外部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" }。