APIキーの発行

Synqlet API へのリクエストには APIキー が必要です。APIキーは組織ごとに、画面の「設定 > APIキー」から発行します。

APIキーを発行する

1. 「設定 > APIキー」を開く

   サイドメニューの設定から「APIキー」の画面を開きます。

2. 「作成」をクリックする

   APIキー作成ダイアログが開きます。

3. APIキー名を入力する

   後から見分けやすいように、用途がわかる名前（例: 本番バッチ連携）を付けます。

4. 「作成」を押す

   APIキーが発行され、キーの文字列が表示されます。

APIキーは作成後に1度だけ表示されます

キーは再表示できません

発行されたAPIキーは 作成直後に1度だけ 表示されます。画面を閉じると二度と表示できません。

表示されている間に コピーボタン でコピーし、安全な場所に保管してください。紛失した場合は、新しいキーを発行し直す必要があります。

APIキーは次の形式の文字列です。

sk_synqlet_<id>_<secret>

このキーをリクエストの X-API-Key ヘッダーに指定して利用します（API の概要 を参照）。

APIキーの取り扱いについて

• APIキーはパスワードと同等の機密情報です。第三者に共有したり、公開リポジトリにコミットしたりしないでください。
• 用途ごとにキーを分けて発行すると、漏えい時の影響範囲を限定できます。
• 不要になったキーや漏えいの恐れがあるキーは、APIキー一覧から削除してください。

発行済みのAPIキーを確認・管理する

「設定 > APIキー」の一覧画面では、発行済みのキーの名前・作成日時・作成者などを確認できます。一覧からキーの削除も行えます。なお、一覧ではキーの文字列そのものは表示されません（マスクされます）。