kintone APIトークンとは?メリット・生成方法からAPI連携の基礎について解説!
![kintoneAPIトークンとは](https://bansonavi.com/wp-content/uploads/2023/06/6.png)
「kintone APIトークンって何?」「kintone APIトークンの生成方法を知りたい」
kintone APIトークンは、kintoneに保存した情報を外部のシステムで閲覧や編集する際のセキュリティ対策のためのツールです。
情報漏えい対策をしながら、外部と必要な情報を共有するのにおすすめです。
今回はAPIトークンのメリットやAPIトークンでできること、生成方法について解説していきます。また、API連携の基礎的な内容にも触れながら説明していきます。
kintone内の情報を外部に共有する必要がある方はぜひ参考にしてみてください。
🔳この記事でわかること
・ kintone APIトークンについての基礎知識
・kintone APIトークンの生成方法や使い方
・kintoneのAPI連携について
🔳こんな人におすすめの記事です
・kintoneのAPIトークンについて知りたい方
・そもそもkintone API連携とは何かを知りたい方
・kintoneのAPI連携を活用したい方
目次
kintone APIトークンとは?
kintone APIトークンとはkintoneで使用される認証情報です。
kintoneと、kintoneの外部にあるシステムやアプリケーションを繋ぐためにアクセスする際に使用される鍵みたいなものです。その鍵を持っている人のみがその指定されたアプリにアクセスできます。
たとえば、建設会社がランドスケープ会社に庭園部分だけを依頼する際に、プロジェクト全体を共有せずに、庭園部分のみの情報や進捗状況を共有したいとします。
そのときに庭園部分だけの情報を保存したアプリと、共有したいアプリ専用のkintone APIトークンを作成して外注先に送ります。
送られた側は、指定された箇所にAPIトークンを入力することで、アプリを開き、中の情報を見たり、コメントなどを入力したりすることができます。
つまり、kintone APIトークンを利用することで、外部の人ともセキュリティを強固なままkintoneに保存した情報の共有がスムーズにできるのです。
🔳APIとは?
「Application Programming Interface(アプリケーション プログラミング インターフェース)」の頭文字を取ったものです。インターフェースとは「何かと何かを繋ぐもの」という意味で、APIの場合はアプリケーションとプログラムを繋ぐものということになります。
🔳トークンとは?
プログラミングコード上でコードを作成するための最小単位の文字の並びのことを指します。
そもそもkintoneのAPI連携とは?
本記事ではAPIトークンについてをメインで紹介していきますが「そもそもAPI連携ってなに?」という方も意外に多いかと思います。
そこでこのパートではAPI連携の基礎的な内容について以下項目で紹介していきますので、初心者の方はぜひしっかり読んでくださいね!
- kintone API連携でできること
- kintone API 連携できる外部サービス一覧
- kintoneのAPI連携を利用してカスタマイズするには?
※APIトークンの解説に飛びたい方はこちらから読み進めてください。
kintone API連携でできること
APIは先に解説した通り「アプリとプログラムを繋ぐもの」です。つまりkintone API連携とはkintone上でアプリとプログラムを連携させることです。
kintone API連携を行うことでアプリ間のデータを連携や外部サービスとの連携も可能になります。例えば、外部サービスの「Google カレンダー」とAPI連携すれば、kintoneアプリで入力された情報を Google カレンダーに反映することができるのです。
これにより、kintoneを使ってあらゆるデータの一元管理やデータの転記・再入力の手間を省くことができるので、作業時間の短縮や入力精度の向上(ミスの削減)が実現できます。
kintone API 連携できる外部サービス一覧
kintoneはAPIのおかげで外部サービスとも連携できます。
一例ではありますが、
- GMail
- Google Drive(スプレッドシートなどにも対応)
- LINE
- Slack
- Chatwork
- Garoon
- Googleカレンダー
- sansan
- MoneyFoward
- freeeサイン など
このように一般的に幅広く活用されているサービスと連携可能。
また、APIを利用したプラグインや拡張機能サービスが幅広く用意されているので、kintoneがより便利につかえるようになるのです。
kintone API連携を利用してカスタマイズするには?
kintone API連携を利用したカスタマイズには、
- APIトークン
- Javascript API
- REST API
の3つが必要です。
まずは鍵となるAPIトークンを生成します。APIトークンを生成することで、指定のデータにアクセスできるようになります。具体的な生成方法は後ほど詳しく解説しますが、早く知りたい方はこちらから確認してくださいね。
APIトークンを取得したら、「JavaScript API」や「REST API」を使うことでアプリ間の連携やkintoneと外部サービスの連携(カスタマイズ)していきます。
kintone APIの種類
kintoneのAPIは「JavaScript API」と「REST API」の2種類あります。それぞれ役割について概要をこのパートで簡単に解説していきます。
kintone JavaScript API
kintone JavaScript APIは、kintone画面の動作や見た目(フロントエンド)をカスタマイズするための橋渡し的な役割を担っています。
イメージ的にはkintoneをJavaScriptでカスタマイズする時に使う道具をまとめたものです。
kintone JavaScript APIを活用すると、フィールドの自動入力や入力規則の設定、Googleカレンダーを連携して情報を反映させるなど、標準機能ではできないカスタマイズが可能になります。
kintone REST API
kintone REST APIはレコード・アプリ・スペース操作等(バックエンド)のデータ連携を可能にします。ざっくりいうと「kintoneのデータにアクセスするためにRESTという規格で設計されたAPI」です。
具体的には、外部システムから kintone へデータを登録・更新・削除するときや、kintone 上のデータを外部システムに送るときに活用します。
※REST APIの仕組みについて確認したい方は下記の記事を参考にしてみてださい。
参考:REST API(RESTful API)とは – 意味をわかりやすく
kintone APIトークンのメリット
ここまでkintone API連携の概要を解説してきたので、それではようやく本題のAPIトークンについて詳細を解説していきましょう。
まずはさまざまあるkintone APIトークンのメリットについて解説します。
APIトークンのメリット①「限られたアプリのみ実行できる」
APIトークンはアプリごとに設定できるため、作成したアプリのみREST API(※)を実行できます。そのため、設定したアプリ以外を実行してしまうリスクを抑えられます。
※REST APIとは、異なるシステムやアプリケーション間でデータの共有や相互操作をするための手段です。インターネット上で情報取得やデータ送信などを行います。
APIトークンのメリット②「実行可能なREST APIの種類を制限できる」
APIトークンはREST APIを実行するためのものですが、実行できる範囲を制限することができます。
たとえばデータの閲覧はできるが、削除はできないといった設定が可能です。
多くの社員が閲覧する場合などで誤って情報を更新してしまったり、削除してしまったりといったリスクを軽減できます。
APIトークンのメリット③「ユーザIDとパスワードの設定不要」
本来REST APIを実行するためにはシステムにユーザIDとパスワードを設定しておく必要があります。
しかし、APIトークンを作成し設定しておけばユーザIDやパスワードは不要です。またREST APIに比べてユーザ情報漏洩のリスクも低く、より高いセキュリティ対策にもなります。
kintone APIトークンでできること
kintone APIトークンを使用すると、以下のようなことができます。
データの取得
kintoneのデータベースから顧客リストや商品データなどの情報を取得できます。
データの作成
顧客情報やタスクなど新しいデータを作成できます。
データの更新
既に登録済みの顧客情報や注文ステータスなどの更新ができます。
ファイルや画像の操作
画像やドキュメントなどファイルのアップロードやダウンロード、削除ができます。
アプリケーションの設定
フィールドの追加や削除、表示レイアウトなど、kintoneのアプリケーションの設定を変更できます。
ほかにもデータの削除やユーザーアカウントの作成や更新、削除なども可能です。APIトークンを使用して実行することで、kintoneのデータや機能を安全に外部から操作することができます。
kintone APIトークン生成方法
kintone APIトークンの生成方法は以下の流れで行います。
①レコード一覧画面の右上にあるアプリ設定ボタンをクリック
![](https://bansonavi.com/wp-content/uploads/2023/07/settinng.png)
②「設定」タブの「カスタマイズ/サービス連携」にある「APIトークン」を選択し、「生成する」をクリック
![](https://bansonavi.com/wp-content/uploads/2023/07/APItokun.png)
③生成されたAPIトークンに許可する操作を「アクセス権」のチェックボックスで選択
④必要に応じてメモ欄に担当者や利用目的などを入力し保存
⑤画面右下にある「保存」をクリックでAPIトークンの設定保存が完了
⑥次に画面右上にある「アプリを更新」、確認ダイアログで「アプリ更新」で運用環境に反映完了
kintone APIトークンのセキュリティ面
REST APIを実行する際、APIトークンを使用することでセキュリティ面はより強固なものになります。
とはいえ、多くの人がアクセスできる外部へと繋がるインターネット上へ情報を流すのは漏洩の危険が伴います。
悪意のある人にデータを操作される恐れもあるため、必要最低限の権限の付与に留めておきましょう。
kintone APIトークンの注意事項
APIトークンで設定したアクセス権は、「アプリのアクセス権」「レコードのアクセス権」「フィールドのアクセス権」より優先されます。
APIトークンの利用はスタンダードコース契約者のみです。また生成できるトークンはアプリ1つにつき20個までです。
kintoneシステム管理権限が必要な操作には対応していないため、管理権限が必要なカスタマイズ形式の一覧の変更はできません。
kintone APIトークンのトラブルシューティング
「アプリ設定のAPIトークンが不正です」とエラー表示されるなど、APIトークンが正しく機能しない場合の対処法をお伝えします。
「APIトークンが不正です」「APIトークンに誤りがあります」と表示される場合、以下の内容を確認して下さい。
操作内容の権限が付与されているか?
}アクセス権には「レコード閲覧」「レコード追加」「レコード編集」「レコード削除」「アプリ管理」があります。
APIトークンの設定が反映しているか?
APIトークンは生成し設定を保存したあとに「アプリを更新」して設定を反映しないと利用できません。
アプリ連携の設定に誤りがないか?
アプリ連携の設定に誤りがある場合、再度設定の必要があります。アプリ連携の編集画面からレコードの取得条件を削除し、再設定してください。
IPアドレスの許可設定がされているか?
cybozu.com側でセキュリティ設定(IPアドレス制限)を行っている場合はセキュリティ設定の変更が必要です。設定方法は「cybozu.comのセキュリティ設定を変更する」を参照してください。
【まとめ】APIトークンとは社内情報を安全に外部と共有するための鍵!
APIトークンとは、kintoneのアプリごとに設定できる鍵みたいなものです。
またアプリ丸々だけではなく、アプリの中でもさらに細かく権限を設定してからAPIトークンを生成することで、閲覧のみ許可するなどの指定もできます。
外注先や顧客との情報共有で、共有したいものだけを安全に共有できるのがAPIトークンです。
IDやパスワードを別に設定する必要がないため、管理の手間も省けます。
業務効率化システムとして優秀なkintoneですが、APIトークンを使用することでより便利に効率よく業務を進めていくことができます。
この記事へのコメントはありません。