將執行外部 API 所需的資訊儲存在外掛程式
將執行外部 API 所需的資訊儲存在外掛程式。
從外掛程式執行外部 API 時,將此 API 儲存的資訊添加到請求的標頭和正文中。
如果要在執行外部 API 時使用保密資訊(例如身份驗證資訊),請事先使用此 API 將所需資訊存儲在外掛程式中。
此 API 只能在外掛程式設定畫面中運行,該畫面僅供應用程式管理員訪問。
這樣可以防止應用程式的使用者存取外掛程式中儲存的資訊。
函數
PC
kintone.plugin.app.setProxyConfig(url, method, headers, data, successCallback)
參數
如果指定的 URL 和 HTTP 方法組合已存在,它將覆蓋外掛程式設置。
參數 | 類型 | 必須 | 說明 |
---|---|---|---|
url | 字串 | 必須 | 要執行的 API 的 URL |
method | 字串 | 必須 | HTTP 方法 指定以下值之一:
|
headers | 物件 | 必須 | 要添加到 API 請求標頭的參數 如果您指定的參數與 從外掛程式執行外部 API 中指定的參數重疊,則以此 API 中指定的參數為準。 如果不指定任何內容,請指定一個空物件。 |
data | 物件 | 必須 | 要添加到 API 的請求資料的請求正文 例: {如指定的 key 與 從外掛程式執行外部 API 中指定的正文中的 key 重複,則以此 API 中指定的 key 的值為準。 如果不指定任何內容,請指定空物件。 |
successCallback | 函數 | 可省略 | 保存外部 API 的請求資訊時執行的回調函數 無參數。 省略 successCallback 時,或指定"undefined"與"null"之一時,系統將移動到應用程序設定的外掛程序清單畫面,並顯示設定完成消息。如指定 successCallback ,則不會重定向到應用程式設定的外掛程式清單畫面。 |
返回值
無
可使用的畫面
PC
- 外掛程式的設定畫面
行動用戶端
無
補充
將儲存的資訊添加到請求的條件
-
使用 從外掛程式執行外部 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。
- URL:"https://api.example.com/foo/operate.json"
- 標頭:
{}
在這種情況下,執行 API 時送出的請求的標頭是
{ "Content-Type": "application/json" }
。 - 設定 1
*1
例如,如果在每個函數中指定以下URL,因 URL 的開頭部分匹配,存儲在外掛程式中的資訊將添加到請求中。
- 獲取執行外部 API 所需的資訊 裡指定的 URL :https://api.example.com/
- 從外掛程式執行外部 API 中指定的 URL:https://api.example.com/operate.json