kintone API文件

傳送kintone REST API請求

information

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

目錄

傳送kintone REST API請求

連結已複製

執行kintone REST API和UserAPI。

函數

連結已複製

電腦版/行動裝置版

kintone.api(pathOrUrl, method, params, successCallback, failureCallback)

參數

連結已複製

參數名稱 類型 必須 說明
pathOrUrl 字串 必須 kintone API路徑或URL
例如，API的URL為「https://sample.cybozu.com/k/v1/records.json」時，指定為「/k/v1/records.json」。
結尾省略「.json」時，生成的URL會自動添加「.json」。
要獲取API的URL，您還可以指定以下API獲取的值。
method 字串 必須 HTTP方法
指定以下值之一：
  • GET
  • POST
  • PUT
  • DELETE
params 物件 必須 要執行的API的請求參數
successCallback 函數 可省略 API呼叫成功時執行的回調函數
傳遞給回調函數的參數的類型是物件。
如果省略，則返回Promise物件，並通過傳遞給successCallback的參數進行解析。
failureCallback 函數 可省略 API呼叫失敗時執行的回調函數
回調函數的參數以JSON格式傳遞錯誤內容。
如果錯誤的內容無法解析為JSON，則傳遞未解析的字串。
如果省略，則返回並Promise物件，並將參數傳遞給failureCallback。

返回值

連結已複製

如果指定successCallback，則沒有返回值。
如果省略參數successCallback，則返回Promise物件。

可使用的畫面

連結已複製

電腦版/行動裝置版

可使用的畫面同整體自訂的套用畫面。
kintone整體自訂的套用畫面
但是，也可以在外掛程式設定畫面中使用。

示例代碼

連結已複製

如何使用回調進行編寫
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const body = {
  app: kintone.app.getId(),
  id: 1
};

kintone.api(kintone.api.url('/k/v1/record.json', true), 'GET', body, (resp) => {
  // success
  console.log(resp);
}, (error) => {
  // error
  console.log(error);
});
如何使用async/await編寫
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

(async () => {
  const body = {
    app: kintone.app.getId(),
    id: 1
  };

  try {
    const resp = await kintone.api(kintone.api.url('/k/v1/record.json', true), 'GET', body);
    // success
    console.log(resp);
  } catch (error) {
    // error
    console.log(error);
  }
})();

限制事項

連結已複製

補充

連結已複製

  • 如果發送的URL長度大於4KBGET請求，則會自動附加「X-HTTP-Method-Override」標頭並作為POST請求發送。
    X-HTTP-Method-Override