APIキー

APIキーを使うと、スクリプトやアプリケーションがサインインせずに、あなたのワークスペースとしてFlowHunt APIを呼び出せます。キーはあなた個人ではなくワークスペースに属するため、キーを使った呼び出しはそのワークスペースに対する操作として扱われます。

キーを作成する#

1. API Keysタブを開く

   アカウントエリアで Settings をクリックし、続いて API Keys タブをクリックします。

2. キーを追加する

   Add API Key をクリックします。Create API Key ダイアログで、キーがどこで使われるかが分かる Name を入力します。例:「Nightly export script」。Add API Key をクリックして確定します。

3. 今すぐコピーする

   次のダイアログにキーと Copy to clipboard ボタンが表示されます。FlowHuntが完全なキーを表示するのはこの一度だけで、再度表示することはできません。シークレットマネージャーや環境変数に保存し、コミットするコードには絶対に書かないでください。

キーを紛失した場合は、新しいキーを作成して古いキーを削除してください。

キーを使用する#

同じダイアログにある Try API key をクリックすると、api.flowhunt.io/docs のAPIリファレンスが開きます。リファレンスにはすべてのエンドポイントが掲載されており、キーの送信方法も確認できます。PHP SDK ボタンは、PHPプロジェクト向けのFlowHunt PHPパッケージへのリンクです。

キーを管理する#

API Keys リストには、各キーの Name、マスクされたキー、Last used（最終使用日時）、Valid to（有効期限）が表示されます。

• 名前変更または有効期限の設定。 キーを開いて Name または Valid to を変更し、Update API Key をクリックします。有効期限は作成後にのみ設定できます。
• キーの削除。 キーを開いて Remove API Key をクリックし、確定します。そのキーを使用しているものはすべて動作しなくなります。
• 検索。 リストの上にある検索ボックスを使ってキーを探します。

Last used を使って、もう誰も必要としていないキーを見つけましょう。一度も使用されていないキー、または何ヶ月も使用されていないキーは、削除の良い候補です。

これを実行できる人#

OwnerとAdminはキーの作成、編集、削除ができます。Editorはリストの閲覧とキーの作成はできますが、編集や削除はできません。Member、Guest、Maintainerにはこのタブが表示されません。詳しくはチームとロールをご覧ください。

作成できるキーの数にプランの上限はありません。キャンセルされたワークスペースではキーを作成できません。