簡単な3ステップで、kintoneのカスタマイズやデータを取得する方法を学びましょう。

kintoneの開発者ライセンスを取得して、すぐに開発を始められます。
kintone開発者ライセンスは、開発者がkintone APIを無料で試すための環境です。

kintone開発者ライセンスを取得する

開発者ライセンスを取得したら、この記事に戻ってください。

開発者ライセンス環境にログインし、アプリを準備しましょう。
ここでは、「顧客リスト」アプリを作成します。

kintoneのポータル画面からアプリを作成する手順は次のとおりです。
「はじめる」をクリックして、動画を参考に「顧客リスト」アプリを作成しましょう。

kintoneには、豊富なJavaScript APIがあります。
kintone JavaScript APIは、kintone上の動作や見た目の変更をするAPIです。

ここでは、レコード登録時にフィールドの初期値を「こんにちは、kintone!」と表示するカスタマイズを追加します。
初期値の設定はフィールド設定画面でも行えますが、この最もシンプルな例を通じてAPIの基本的な使い方を紹介します。
まず、備考フィールドのフィールドコードをnoteに設定します。
「はじめる」をクリックして、動画を参考に設定しましょう。

フィールドコードの設定までできたら、次のコードを任意のエディタにコピー＆ペーストして、hello-kintone.jsとしてファイルを保存します。

1
2
3
4

kintone.events.on('app.record.create.show', (event) => {
  event.record.note.value = 'こんにちは、kintone!';
  return event;
});

アプリの設定画面の「JavaScript / CSSでカスタマイズ」を開きます。
「PC用のJavaScriptファイル」に先ほど保存したhello-kintone.jsファイルをアップロードします。

アプリでレコード追加画面を開いた際に、備考フィールドの初期値に「こんにちは、kintone!」と表示されていればカスタマイズが成功しています。

コード内のapp.record.create.showは、 レコード追加画面を表示した後のイベント です。
同様に、他の画面や保存時、編集時などさまざまなイベントのAPIがあります。
詳しくは イベント を確認してください。

次は、kintone REST APIでkintone上にあるデータを取得してみましょう。
kintone REST APIは、kintone内のデータを操作するためのAPIです。
データの取得／登録／更新／削除、ファイルのアップロード／ダウンロードが可能です。

APIのリクエストには、アプリIDとレコードIDを含める必要があります。
これらのパラメーターを確認するには、「顧客リスト」アプリのレコード詳細画面に移動します。
このとき、アプリIDとレコードIDは、URLに次のように表示されています。

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には、3つの異なる認証タイプがあります。
ここでは、APIトークン認証を使用します。
詳細は、 kintone REST API共通 認証 を参照してください。

「顧客リスト」アプリの設定から、「APIトークン」を開きます。
新しいトークンを生成します。

注意

APIトークンをアプリで使用できるようにするには、「アプリを更新」を必ずクリックしてください。

ここまでで、次の情報が準備できました。

• アプリIDとレコードID
• リクエストURL
• APIトークン

この情報を使用して、kintoneのデータを取得するcURLコマンドを次のように組み立てます。
APIトークンで認証する場合は、X-Cybozu-API-Tokenヘッダーを使用します。

1
2

curl -X GET -H 'X-Cybozu-API-Token:<APIトークン>' \
  '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":"情報システム部"}は、フィールドコード部署名が文字列（1行）フィールドで、値が「情報システム部」のデータを示しています。

このように、kintoneのデータは外部から取得可能のため、他のサービスとのさまざまな連携に使用されています。

わずか3つの簡単なステップで、kintoneのAPIでのUIカスタマイズとデータ取得ができました。
kintoneには、他にも多くのAPIがあり、カスタマイズ性の高さが魅力です。

• kintone JavaScript API一覧
• kintone REST API一覧

次は、チュートリアルでもう少し詳しく、カスタマイズの基本を体系的に学んでみましょう。