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: {},
 *  }
 **/