1. HOME
  2. ブログ
  3. kintone APIトークンとは?メリットや生成方法について解説!

kintone APIトークンとは?メリットや生成方法について解説!

kintoneAPIトークンとは

「kintone APIトークンって何?」「kintone APIトークンの生成方法を知りたい」
kintone APIトークンは、kintoneに保存した情報を外部のシステムで閲覧や編集する際のセキュリティ対策のためのツールです。
情報漏えい対策をしながら、外部と必要な情報を共有するのにおすすめです。

今回はAPIトークンのメリットやAPIトークンでできること、生成方法について解説していきます。
kintone内の情報を外部に共有する必要がある方はぜひ参考にしてみてください。

kintone APIトークンとは?

kintone APIトークンとはkintoneで使用される認証情報です。
kintoneと、kintoneの外部にあるシステムやアプリケーションを繋ぐためにアクセスする際に使用される鍵みたいなものです。その鍵を持っている人のみがその指定されたアプリにアクセスできます。

たとえば、建設会社がランドスケープ会社に庭園部分だけを依頼する際に、プロジェクト全体を共有せずに、庭園部分のみの情報や進捗状況を共有したいとします。
そのときに庭園部分だけの情報を保存したアプリと、共有したいアプリ専用のkintone APIトークンを作成して外注先に送ります。
送られた側は、指定された箇所にAPIトークンを入力することで、アプリを開き、中の情報を見たり、コメントなどを入力したりすることができます。

つまり、kintone APIトークンを利用することで、外部の人ともセキュリティを強固なままkintoneに保存した情報の共有がスムーズにできるのです。

APIとは?

「Application Programming Interface(アプリケーション プログラミング インターフェース)」の頭文字を取ったものです。インターフェースとは「何かと何かを繋ぐもの」という意味で、APIの場合はアプリケーションとプログラムを繋ぐものということになります。

トークンとは?

プログラミングコード上でコードを作成するための最小単位の文字の並びのことを指します。

kintone 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トークンの生成方法は以下の流れで行います。

①レコード一覧画面の右上にあるアプリ設定ボタンをクリック

②「設定」タブの「カスタマイズ/サービス連携」にある「APIトークン」を選択し、「生成する」をクリック

③生成された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トークンを使用することでより便利に効率よく業務を進めていくことができます。

伴走ナビ管理人
サイボウズパートナーのペパコミ株式会社で年間100社以上のkintone構築と伴走サポートの案件に携わり、kintoneだけでなくプラグイン設定も数多く経験。システム機能だけではなく、社内業務コンサルとしての目線で中小企業のDX化を推進しています。
  1. この記事へのコメントはありません。

  1. この記事へのトラックバックはありません。

       

関連記事

今すぐ伴走ナビ公式LINEに登録する 最新記事を通知 公式LINEはこちら 毎月5社限定 無料相談はこちら