イントロダクション

目次

「はじめようkintone API」とは

「はじめようkintone API」シリーズは、kintoneのカスタマイズが初めての方向けに、kintoneカスタマイズの基本を学ぶためのコンテンツです。
プログラミングが初めてでJavaScriptの書き方を学びたい方は、 はじめようJavaScript で学習してから「はじめようkintone API」シリーズの学習を始めてください。

このシリーズで学べること

このシリーズを学習し終えると、次のことができるようになります。

  • kintone JavaScript APIとkintone REST APIの違いがわかる。
  • kintoneアプリにカスタマイズファイルを適用する。
  • kintone JavaScript APIを使って、レコードの画面のカスタマイズや、レコードのデータを編集する。
  • kintone REST APIを使ってレコードのデータを取得する。
  • kintoneカスタマイズが動かない場合に、ブラウザーの開発者ツールを使ってデバッグする方法がわかる。
  • カスタマイズビューを使って、独自のレコード一覧画面を作成する。
  • kintone Webhookの使い所と注意点がわかる。

kintoneカスタマイズとは

kintoneは標準機能でさまざまなことができます。
JavaScriptカスタマイズすることで、標準機能だけでは難しい機能も実現できるため、より自社に合ったシステムを構築できます。

  • レコード一覧画面にボタンを設置し、合計値を出力
  • 条件によって文字や背景の色やサイズを変更
  • 計算フィールドでは実現できない複雑な計算

JavaScriptが実行できるようになると、ボタンを設置しそれを押したときの処理を決めたり、データの計算処理をしたりなど、kintone上の動作や見た目の変更 ができます。
さらに、kintone APIと組み合わせることで、任意のレコードを取得したり更新や削除をしたり、kintone内のデータ連携ができます。

手間が省けたり、人的ミスを減らせたりできるのが、kintoneカスタマイズの魅力の1つです。

kintone APIについて

kintone APIには大きく分けて2種類あります。
kintone JavaScript APIとkintone REST APIです。それぞれ説明します。

kintone JavaScript API

kintone JavaScript APIは、kintone上の動作や見た目の変更するAPIです。
具体的には、表示するフィールドの切り替え、住所情報を元にした地図表示などが可能です。
JavaScriptファイルをアプリにアップロードして適用することで、ユーザーのkintone画面上で動作します。
kintoneには、さまざまなJavaScriptイベントがあり、動作を変更できます。

kintone REST API

kintone内のデータを操作するためのAPIです。
レコードの取得/登録/更新/削除や、ファイルのアップロード/ダウンロードのAPIがあります。
また、アプリの情報取得やフォームの情報取得のAPIもあります。

kintone JavaScript APIとkintone REST APIの違い

JavaScriptはブラウザーで使用されるプログラミング言語なので、画面(ブラウザー)上の情報を取得して操作するときに使用します。
kintone JavaScript APIだけではブラウザーに表示されていない情報、たとえば別のアプリのデータを取得したり操作したりはできません。
例のように別のアプリのデータを取得・操作したい場合、kintone REST APIを使用します。

kintone REST APIはいわゆる一般的なWeb APIです。外部サービスからkintoneのデータを操作する場合にもkintone REST APIを使います。
kintoneの画面上の情報の取得や操作をしたい場合はkintone JavaScript API、kintoneの画面にはないデータの取得や操作をしたい場合はkintone REST APIと覚えましょう。

まとめ

kintoneカスタマイズの世界へようこそ。
このシリーズではkintoneのカスタマイズ方法や、カスタマイズをする上での注意点などを学んでいきます。
最後まで学べば、ドキュメントを読んでカスタマイズをしていく基礎知識が身に付きます。
自分のペースで学習を進めていきましょう。

次は、 カスタマイズファイルを適用してみよう で実際にカスタマイズをやってみましょう。

tips
補足

kintoneの最新の技術情報は、X(旧Twitter)で紹介しています。
@kintonedevjp (External link) フォローし、チェックしましょう。