イントロダクション

目次

「はじめよう 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 で kintone カスタマイズをすることでより自社に合ったシステムを作り上げることができます。

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

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 のカスタマイズ方法や、カスタマイズをする上での注意点などを学んでいきます。
最後まで学べば、ドキュメントを読んでカスタマイズをしていく基礎知識が身に付きます。
自分のペースで学習を進めていきましょう。

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