kintone（キントーン）の２つのAPI

こんにちは。kintone（キントーン）導入支援のギャンです。
今回は「kintoneの2つのAPI」ということでkintone REST APIとkintone javaScript APIについてまとめてみました。

APIとは

APIとは、アプリケーション・プログラミング・インタフェース（Application Programming Interface）の略称で、ソフトウェアやプログラム、Webサービスの間をつなぐインターフェースのことを指します。 APIには、サブルーチン、データ構造、オブジェクトクラス、変数などの仕様が含まれます。

kintoneのAPI

kintoneのAPIには、大きく２つあります。１つはデータ連携のためのAPIである「kintone REST API」で、レコードの取得／登録／更新／削除や、ファイルのアップロード／ダウンロードのAPIがあります。また、アプリの情報取得やフォームの情報取得のAPIもあります。もう１つはkintoneの画面上の動作や見た目を変えるAPIである「kintone JavaScript API」があります。JavaScriptファイルをアップロードして適用することで、ユーザーのkintone画面上で動作します。kintoneには様々なJacaScriptイベントがあり、動作を変更できます。

kintone REST API

kintone REST API は、kintone のアプリやレコード、スペースを操作できる API です。kintone に格納されているデータを操作することができ、レコードの検索・登録・更新・削除のほか、ファイルのアップロード／ダウンロードが可能です。例えば外部システムのデータをkintoneへ連携する際などのAPI連携にkintone REST APIを利用できます。kintone REST APIを実行するには、URL、メソッド、リクエストヘッダー、リクエストパラメーターが必要です。URLはkintoneのどのリソースに対してリクエストを行うのかを指定するURLです。メソッドはURL で指定したリソースをどう扱うのか指定するためのものでGET／POST／PUT／DELETE のいずれかを指定します。リクエストヘッダーはAPIをリクエストするための認証情報を設定します。リクエストパラメーターはリクエストの内容によって異なりますが、アプリIDやレコードIDなどを設定します。詳しくはこちらを参照してください。

kintone JavaScript API

kintone JavaScript API は、ブラウザーの画面上の情報を取得・操作できる API です。kintone には独自のメソッドが複数用意されており、さまざまな情報が取得できます。JavaScript では、 addEventListener() を使ってイベントと関数を紐付けますが、kintone には独自のイベントがあり、その独自イベントと関数を紐付けるために kintone.events.on() を利用します。kintoneのイベントは画面の種類ごとに異なります。例えばレコードの詳細画面を開いた際に、処理を実行したい場合には、レコードの詳細画面を開いた際のイベントを指定し、処理と紐づけます。kintone JavaScript APIを利用してkintoneの画面のカスタマイズなどを行うことができます。kintone JavaScript APIの詳細については、こちらを参照してください。

kintoneの２つのAPIのまとめ

kintone REST APIは、外部システム（サービス）とkintoneを連携する際に利用しますが、開発言語はVBAでもPHPでもJavaでもpytonでも何でも問題ありません。APIを呼び出すことができてデータの処理ができればOKです。なお、データはJSON形式になりますので、JSON形式が扱い易い開発言語の方が利用しやすいかと思います。kintone JavaScript APIは、kintoneをJavaScriptでカスタマイズする際に利用できますが、主に一覧表示の際や、編集画面の保存時など、イベントに合わせて画面表示等を行ったりする際に利用できます。このようにkintoneのAPIは仕様が公開されていますので、誰でも利用することが可能です。またAPIを活用してkintoneとの連携サービスや、kintoneのプラグインを開発することも可能ですので、機会があれば挑戦してみてはいかがでしょうか？