kintoneのAPI連携について基本を徹底解説！APIを活用したプラグインの事例も紹介

この記事はM-SOLUTIONS株式会社の提供するkintoneとChatGPT(AI)を連携するサービス「Smart at AI for kintone Powered by GPT」によって執筆され、M-SOLUTIONSが加筆・修正しました。

kintoneのAPIを利用すると、kintoneを外部システムとの連携やカスタマイズすることが可能です。
しかし、初めて使う場合はどうやって使えばいいのか分からず、困ってしまうこともありますよね。

そこで本記事では、APIの基本から、開発、サポート、連携のメリット、成功事例まで、幅広く解説しています。
kintoneのAPIの基本について知りたい方はこの記事だけで概要を把握できます。

kintoneのAPI連携とは？基本を解説

まず、APIとは「アプリケーション・プログラミング・インタフェース(Application Programming Interface)」の略で、アプリケーション同士を連携する接点のことです。
APIは非常に身近な存在で、私たちの身の回りでも

• Googleマップ
• SNS
• LINE

などでも利用されています。

APIは業務改善プラットフォーム「kintone」でも利用することが可能です。
kintoneのAPI連携を利用することで、上記のような外部のソフトウェアやシステムからデータを連携させるなど、機能を拡張させることが可能となり、アプリケーションの開発や業務効率化を実現します。

kintoneのAPI連携の基本的な使い方は、REST APIとJavaScript APIの2つがあります。

kintone REST API は、kintone のレコードやアプリ、スペースを操作できる API です。
kintone で管理しているデータを外部システムに渡すときや、外部システムから kintone へデータを登録、更新、削除するときに利用できます。

kintone JavaScript API は、ブラウザーの画面上の情報を取得・操作できる API です。
kintone には独自のメソッドが複数用意されており、さまざまな情報が取得できます。

引用：https://cybozu.dev/ja/tutorials/hello-kinapi/js-api/

kintoneのAPI連携を利用して開発をするには？

kintoneのAPI連携を利用し開発を始めるには、まずAPIトークンの生成が必要です。
kintoneのAPIトークンを生成する方法はこちらをご覧ください。

APIトークンを取得したら、REST APIやJavaScript APIを使ってkintoneのデータを登録、更新、削除することができます。
ただし、APIを使ったアプリケーション開発には、JavaScriptの基本的な知識やREST APIの基礎的な使い方が必要です。

kintoneのAPI連携でアプリケーションを開発するの際は、kintone developer networkにアクセスすることをおすすめします。
developer networkには、kintone APIのチュートリアルやサンプルコード、ドキュメントなどが豊富に公開されています。

kintoneのAPI連携で開発をする場合は「kintone API ドキュメント」がオススメ

kintone developer networkの「kintone APIのドキュメント」には、REST APIとJavaScript APIの仕様や使用方法、エラーコードなどが記載されています。

kintone APIドキュメントを使って必要な情報を見つけるには、右上の検索ボックスにキーワードを入力し、関連するページを探す方法も良いでしょう。

また、kintone APIドキュメントには、REST APIやJavaScript APIのサンプルコードも掲載されています。
サンプルコードを使って、実際にAPIを使う方法を学ぶことができます。 

kintoneのAPI連携で問題が起きたときの対処法

kintoneのAPI連携の際、問題が発生することがあります。
その場合は、まずエラーコードを確認し、どのようなエラーが発生したのかを把握します。

しかし、エラーコードを確認しても解決できない場合は、kintone developer network には技術者同士のコミュニティもあり、プログラミングのお困りごとを質問・相談することもできます。
非常に活発なコミュニティなので、技術者の方は一度覗いて見ることをオススメします。

kintoneのAPI連携で何ができるのか？活用事例を紹介

kintoneのAPI連携を使うことで、外部システムとの連携やカスタマイズが可能になった事例をご紹介します。

kintoneのAPI連携を活用した事例としては、下記のようなものがあります。

• 請求書自動作成
  請求書自動作成では、kintoneに登録された情報を元に、自動的に請求書を作成。
  
• 名刺管理の効率化
  外部の名刺管理ツールのデータを、kintoneに一括登録・更新。

kintoneのAPI連携のメリットとは？

先述通りkintoneはAPIを利用することで、外部のソフトウェアやシステムからデータを連携させ、機能を拡張させることが可能となり、アプリケーションの開発や業務効率化を実現します。

例えば、kintoneと連携ができる外部サービスは下記のものがあります。

• Amazon
• Google
• SendGrid
• Box
• LINE WORKS

上記以外にも外部連携可能なサービスがありますので、詳しくはこちらをご覧ください。

M-SOLUTIONSの提供するプラグインでAPIを利用しているものを紹介

M-SOLUTIONSの提供するプラグインではkintone APIや外部のAPIを利用し、kintoneに便利な機能を追加しています。
APIを駆使すると、下記のような魅力的な機能を開発することが可能です。

１、検索拡張プラグイン

＜kintone APIを利用＞
kintoneのレコード一覧画面上に検索窓を追加して kintoneのレコード検索の手間を削減してくれるプラグインです。
kintoneの絞り込み検索をせずに、キーワードで簡単に情報検索が可能になります。

検索拡張プラグインの事例

２、クラウド連携プラグイン for Box

＜外部 APIを利用＞

クラウドストレージの「Box」とkintoneを連携するプラグインです。
kintone上での大容量ファイル管理が可能となり　社内・社外問わず情報共有がスムーズに実現できます。

クラウド連携プラグイン for Boxの事例

kintone カスタマイズよりもプラグインがオススメな理由

各担当者が個人でkintoneカスタマイズするよりも”まずはプラグインの導入”をオススメします。

プラグインがオススメな理由①：簡単にすぐに導入できる。

kintoneのプロが開発した、高性能なプラグインはkintoneにzipファイルを取り込むだけで導入可能です。

個人で開発する時間や労力を圧倒的に節約することができます。

プラグインがオススメな理由②：安全

正しく開発を行わないと外部サービスのAPIキーが漏れ、不正利用されてしまう可能性もあります。
安全対策としても、まずはプラグインでお悩みを解決できないか検討してみましょう。

プラグインがオススメな理由③：外部サービスに認められたプラグインもある

前述した「クラウド連携プラグイン for Box」はBoxのエコシステムソリューションに登録されています。

つまり、本製品からのBox利用時は、Boxの「月当たりのAPIコール数」に対するカウントの対象外となっています。

APIコール数は上限があり、連携したいサービスによってはAPI費用が利用回数に応じてかかる場合があり、個人で開発する結果、想定よりも費用がかかることがあります。

最後に

kintoneはAPIを使って業務プロセスを自動化し、業務効率化を図ることができます。
ぜひ、本記事を参考にして、kintoneのAPI活用のキッカケにしてみてください。

APIを使うのは難しいなという方は記事の後半でご案内したようなプラグインも検討してみてくださいね。
kintoneに簡単に高性能な機能を追加することができますよ。

この記事はM-SOLUTIONS株式会社の提供するkintoneとChatGPT(AI)を連携するサービス「Smart at AI for kintone Powered by GPT」によって執筆され、M-SOLUTIONSが加筆・修正しました。