kintone API文件

獲取執行外部 API 所需的資訊

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

獲取執行外部 API 所需的資訊

連結已複製

使用以下 API 獲取在運行外部 API 時添加到請求的標頭和資料的資訊。
從外掛程式執行外部 API
新增到要求的資訊是您為以下 API 指定的資訊：
將執行外部 API 所需的資訊儲存在外掛程式API

函數

連結已複製

電腦

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

參數

連結已複製

參數 類型 必須 說明
url 字串 必須 要執行的 API 的 URL
method 字串 必須 HTTP 方法
指定以下值之一：
  • GET
  • POST
  • PUT
  • DELETE

返回值

連結已複製

執行外部 API 所需的資訊以「key:value」配对的物件形式返回。

參數名稱 類型 說明
headers 物件 在以下 API 中：headers中指定的請求標頭
從外掛程式執行外部 API
data 物件 在以下 API 中：data中指定的請求正文
將執行外部 API 所需的資訊儲存在外掛程式API
null 條件

可使用的畫面

連結已複製

  • 每個外掛程式的設定畫面

示例代碼

連結已複製

這是使用此 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對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 所需的資訊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: {},
*  }
**/