APIキーを管理する

APIキーは、スクリプトやアプリケーションがKolleKのAPIを通じてあなたの代わりに操作するための個人用トークンです。このページでは、キーの作成、把握、失効というライフサイクルを説明します。キーで実際に何ができるかについては開発者向けセクションを参照してください。

APIを使う予定が全くない場合は、このページは読み飛ばして構いません。作成しない限り、キーは存在しません。

キーを作成する

APIキーの設定を開く

プロフィールに移動し、APIキーのエリアを開きます。すでにキーがあれば、それぞれの最終使用日とともに表示されます。

新しいキーに名前を付ける

キーの作成を選び、それが何のためのものかを示すラベル(「インポートスクリプト」「自宅ダッシュボード」など)を付けます。ラベルは、将来の自分がどのキーを失効させても安全か判断するためのものです。

トークンをすぐにコピーする

作成直後の一度だけ、KolleKがトークンを表示します。今すぐコピーして、パスワードマネージャーなど安全な場所に保管してください。

::screenshot{label="トークンが一度だけ表示された新しいAPIキー"}

警告

トークンが表示されるのは一度だけです。失くしてしまうと、もう一度見ることはできません。そのキーを失効させ、新しいキーを作成してください。

自分のユーザーでキーが作成されるたびに、KolleKから通知メールが届くため、身に覚えのないキーを見逃すことはありません。

APIキーのエリアには、すべてのキーがラベルと最終使用日時とともに一覧表示されます。この最終使用日時は頼りになる情報です。何か月も使われていないキーはおそらく失効させて問題なく、逆にスクリプトを実行していないはずなのに5分前に使われたキーは調査すべきものです。

これを管理しやすく保つコツが1つあります。用途ごとに1つのキーを使うことです。各連携先が専用のキーを持っていれば、他に影響を与えることなく1つだけ失効させられます。

同じ一覧からキーを削除します。そのトークンをまだ使っている処理はすぐに動作しなくなり、KolleKから削除の通知メールが届きます。

次のような場合はキーを失効させましょう。

メモ

APIを通じてサインインする際にも、裏側でトークンが作成されます。これらのサインイントークンはキー作成のメールを発生させないため、受け取るアラートは常に意味のある情報であり続けます。

このページは役に立ちましたか？