透過簡單的三個步驟，學習使用kintone API進行自訂與資料取得的方法。

取得kintone開發者許可證，即可立即開始開發。
kintone開發者許可證是一個讓開發者免費試用kintone API的環境。

取得 kintone開發者許可證

取得開發者許可證後，請返回這篇文章。

登入開發者許可證環境，準備應用程式。
在此我們建立「顧客名單」應用程式。

從kintone入口網站建立應用程式的步驟如下。
點擊「開始」，參考影片建立「顧客名單」應用程式。

kintone 提供豐富的 JavaScript API。
kintone JavaScript API是用於變更kintone動作和外觀的API。

在此，我們新增一個在新增記錄時，讓備注欄位的預設值顯示「Hello, kintone!」的自訂。
雖然初始值也可以在欄位設定畫面設定，但透過這個最簡單的範例，介紹API的基本使用方式。
首先，將備注欄位的欄位代碼設為note。
點擊「開始」，參考影片進行設定。

設定好欄位代碼後，將以下程式碼複製並貼至任意編輯器，存儲為hello-kintone.js檔案。

1
2
3
4

kintone.events.on('app.record.create.show', (event) => {
  event.record.note.value = 'Hello, kintone!';
  return event;
});

開啟應用程式設定畫面的「使用JavaScript/CSS自訂」。
將剛才儲存的hello-kintone.js檔案上傳至「PC用JavaScript檔案」。

在應用程式中開啟新增記錄畫面時，若備注欄位的預設值顯示「Hello, kintone!」，則代表自訂成功。

程式碼中的app.record.create.show是 顯示新增記錄畫面後的事件 。
同樣地，還有其他畫面、儲存時、編輯時等其他事件的API。
詳情請見 事件 。

接著，使用kintone REST API取得kintone的資料。
kintone REST API是用於操作kintone內資料的API。
可進行資料的取得／新增／更新／刪除，以及檔案的上傳／下載。

API請求需包括應用程式ID以及記錄ID。
要確認這些參數，請前往「顧客名單」應用程式的記錄詳情畫面。
此時，應用程式ID與記錄ID在網址中可以查看，如下：

1

https://<子網域>.cybozu.com/k/<應用程式ID>/show#record=<記錄ID>

例：kintone子網域為sample的情況
https://sample.cybozu.com/k/42/show#record=20的情況

REST API的URL格式如下：

1

https://<子網域>.cybozu.com/k/v1/record.json

範例：kintone子網域為sample時
https://sample.cybozu.com/k/v1/record.json

加上應用程式ID和記錄ID，最終的請求URL如下：

1

https://<子網域>.cybozu.com/k/v1/record.json?app=<應用程式ID>&id=<記錄ID>

結合前述範例，請求URL如下：

1

https://sample.cybozu.com/k/v1/record.json?app=42&id=20

kintone REST API有三種不同的認證類型。
本次使用API Token認證。
詳細資訊請參閱 kintone REST API共通認證 。

從「顧客名單」應用程式的設定，開啟「API Token」。
產生一個新的Token。

謹慎

要讓API Token可在應用程式中使用，請務必點擊「更新應用程式」。

至此，已準備好以下資訊：

• 應用程式ID與記錄ID
• 請求URL
• API Token

利用這些資訊，組合出取得kintone資料的cURL指令如下。
若使用API Token認證，請使用X-Cybozu-API-Token標頭。

1
2

curl -X GET -H 'X-Cybozu-API-Token:<API Token>' \
  'https://<子網域>.cybozu.com/k/v1/record.json?app=<應用程式ID>&id=<記錄ID>'

例如，以下條件取得記錄的情況：

指令如下。

1
2

curl -X GET -H 'X-Cybozu-API-Token:DjsLvFiyqwDTDxJJSXnNiAuGARpPMnUIYzFluegQ' \
  'https://sample.cybozu.com/k/v1/record.json?app=42&id=20'

用CLI工具執行此指令。
指定記錄的資料會以JSON格式回傳。（輸出結果較長，部分省略）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "record": {
    "記錄號碼": {
      "type": "RECORD_NUMBER",
      "value": "20"
    },
    "部門": {
      "type": "SINGLE_LINE_TEXT",
      "value": "資訊系統部門"
    },
    "負責人": {
      "type": "SINGLE_LINE_TEXT",
      "value": "下山 達士"
    },
    "郵件地址": {
      "type": "SINGLE_LINE_TEXT",
      "value": "shimoyama_tatsuhito@example.com"
    },
    ...
  }
} 

回應的第一個屬性為record。
record屬性中的屬性是記錄內的各欄位。

例如，鍵值對"部門":{"type":"SINGLE_LINE_TEXT","value":"資訊系統部門"}表示欄位代碼「部門」是單行文字欄位，值為「資訊系統部門」的資料。

如此一來，kintone的資料可從外部取得，因此廣泛應用於與其他服務的各種整合。

只需三個簡單步驟，就能使用kintone API進行介面自訂與資料取得。
kintone還有許多其他API，高度的客製化彈性是其魅力所在。

• kintone JavaScript API清單
• kintone REST API清單

接下來，讓我們透過教學，更詳細、系統地學習自訂的基礎知識。