kintoneのカスタマイズに利用できる各種API

こんにちは、エミックの松尾です。これまでの記事においてkintone JavaScript APIやkintone REST APIについて触れたことがありましたが、kintoneには機能を拡張するためのAPIが用意されています。今回の記事では、kintoneのカスタマイズに利用できる各種APIの概要について記しています。

kintoneはJavaScriptでカスタマイズが可能

kintoneは、プラグラミングをせずに業務改善に役立つアプリを容易に作成できるクラウドサービスですが、プログラマー向けにJavaScriptやCSSで機能を拡張する方法も用意されています。「基本はノーコードだが機能を拡張する方法が用意されている」ことがkintoneの良いところである点については以前の記事でも述べました。

キントーンについて、高い見識からフィードバックをいただきました。 https://t.co/2BCkeOEuJS

— 青野慶久/aono@cybozu (@aono) March 3, 2020

kintoneはJavaScriptを使って呼び出せるkintone APIを利用することでさまざまなカスタマイズが可能であり、画面上の動作や見た目を変更したり、kintoneと外部サービス間でデータを連携させたりできるようになります。

カスタマイズにはスタンダードコースが必要

kintoneには2つのコースが用意されており、スタンダードコースとライトコースの2種類から選べます。

JavaScriptやCSSを使用したカスタマイズは、スタンダードコースでのみ利用できます。ライトコースの場合には利用できません。そのため、kintoneの各種APIを使用するにはスタンダードコースを利用している必要があります。

kintone JavaScript APIで画面上の動作や見た目を変更

kintone APIには、画面上の動作や見た目を変える際に使える“kintone JavaScript API”と呼ばれるAPIが用意されています。

kintone JavaScript API（イベント）一覧

APIを使用したJavaScriptファイルをアプリにアップロードして適用すると、ユーザーが操作する画面上で動作するようになっています。kintone JavaScript APIにはさまざまなイベントがあり、任意のタイミングでいろいろな処理を実行させることができるようになっています。

kintone REST APIで外部サービスとデータ連携

kintone APIには、データ連携の際に使える“kintone REST API”と呼ばれるAPIが用意されています。

kintone REST API一覧

kintone REST APIは、FileMaker プラットフォームにおけるFileMaker Data APIに相当するものであると言えます。レコードデータの取得・登録・更新・削除や、ファイルのアップロードおよびダウンロードのためのAPI、アプリの情報取得およびフォームの情報取得用のAPIなどを利用できます。

プラグイン開発時に使うkintone Plug-in API

kintone APIには、kintone用のプラグインを作成する際に使える“kintone Plug-in API”と呼ばれるAPIも用意されています。

kintone プラグインJavaScript API

プラグインの設定情報を保存、取得したり、プラグインから外部のAPIを実行したり、プラグインから外部にファイルをアップロードする際に使用できるAPIなどがあります。

kintoneから組織情報を操作するためのUser API

kintone API以外に、cybozu.comにおけるサービス共通のAPIとして“User API”も用意されています。ユーザーやグループ、組織、役職などをインポートもしくはエクスポートできるAPIであり、kintoneから組織情報を操作できます。

User API の共通仕様

チュートリアルでカスタマイズ方法を学習

kintone APIの詳細は“kintone API ドキュメント”に記載されており、cybozu developer networkに用意されているチュートリアルでは、kintoneのカスタマイズ開発で必要な知識を段階的に学習することができます。

kintone API

チュートリアルを進めるには開発用に使えるkintone環境が必要になります。kintoneのカスタマイズに興味がある方は是非kintone 開発者ライセンスを取得した上でチュートリアルを進めてみてください。

なお、kintone 開発者ライセンスの概要や取得方法については以前の記事を参照してください。

まとめ

今回の記事では、kintoneのカスタマイズに利用できる各種APIの概要について解説しました。kintone APIには、画面上の動作や見た目を変える際に使える“kintone JavaScript API”やデータ連携用の“kintone REST API”、プラグイン開発用の“kintone Plug-in API”があります。また、cybozu.comにおけるサービス共通のAPIとして、kintoneから組織情報を操作できる“User API”も用意されています。kintoneは標準機能でさまざまなことができますが、JavaScriptを用いてカスタマイズすれば標準機能だけでは実現できないようなことも実現できるようになります。