> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 認証

> API キーを作成し、リクエストを認証します。

> [!NOTE]
>
> GetQR API はベータ版で、一部のワークスペースでのみご利用いただけます。正式リリースまでに内容が変更される場合があります。

GetQR API は、すべてのリクエストをアカウントの API キーで認証します。キーはユーザーごとに 1 つで、1 つのワークスペースであなたとして動作します。

## 始める前に

* ワークスペースのオーナーまたは編集者である必要があります。閲覧者は API キーを作成することも使うこともできません。
* ワークスペースのオーナーに有効なサブスクリプションが必要です。

## API キーを作成する

**1. アカウント設定を開く**

アカウント設定を開き、**API** に移動します。

**2. キーを生成する**

**Generate API key** をクリックします。

**3. キーをコピーする**

キーを表示してコピーします。キーは `sk_live_` で始まります。

キーはいつでも再表示してコピーできます。設定画面には、キーの作成日時と最終使用日時も表示されます。

## リクエストを認証する

すべてのリクエストの `Authorization` ヘッダーで、キーを Bearer トークンとして送ります。

```bash theme={null}
curl "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer sk_live_..."
```

| 問題 | レスポンス |
| - | - |
| `Authorization` ヘッダーがない | `401 unauthorized`: "Missing Authorization header." |
| ヘッダーが `Bearer ` で始まっていない | `400 bad_request`: "Misconfigured authorization header. Did you forget to add 'Bearer '?" |
| 不明なキー、または再生成されたキー | `401 unauthorized`: "Unauthorized: Invalid API key." |
| 役割が閲覧者 | `403 forbidden`: "API access is not available for this role." |
| ワークスペースのオーナーのサブスクリプションが有効でない | `403 forbidden`: "Access denied: This account does not have an active subscription." |
| ワークスペースで API が有効になっていない | `404 not_found`: "This endpoint is not available." |

キーなしで使えるエンドポイントは [ヘルスチェック](https://docs.getqr.com/ja/api/endpoints/health.md) だけです。

## アクセスと役割

* **役割。** API キーを作成して使えるのは、ワークスペースのオーナーと編集者だけです。閲覧者は使えません。
* **ワークスペース。** 各キーは 1 つのワークスペースに属し、すべてのリクエストはそのワークスペースで実行されます。ワークスペース ID を渡す必要はありません。
* **リクエストごとの確認。** アクセス権は、リクエストのたびに現在の役割とワークスペースのオーナーのサブスクリプションに基づいて確認されます。あなた自身のサブスクリプションは関係ありません。役割が閲覧者に変わったり、オーナーのサブスクリプションが終了したりすると、アクセスが回復するまでリクエストは `403` を返します。新しいキーは不要です。
* **削除。** ワークスペースから削除されると、API キーも削除されます。再度追加された場合は、新しいキーを生成してください。

## キーを再生成する

キーが漏えいした場合や、持つべきでない人がアクセスできるようになった場合は、キーを再生成します。

> [!WARNING]
>
> 現在のキーはすぐに使えなくなります。そのキーを使っているアプリや連携は、新しいキーに更新するまで動作しません。

**1. Regenerate をクリックする**

アカウント設定で **API** に移動し、**Regenerate** をクリックします。

**2. 確認する**

**Regenerate key** をクリックします。

**3. アプリを更新する**

新しいキーをコピーし、古いキーを使っているすべての場所で置き換えます。

## キーを安全に保管する

キーはパスワードと同じように扱ってください。キーを持っている人は誰でも、ワークスペースの QR コードを作成、変更、削除できます。

* キーはソースコードではなく、環境変数またはシークレットマネージャーに保存します。
* API はサーバーからのみ呼び出します。Web サイト、モバイルアプリなど、ユーザーが中身を調べられる場所には決してキーを置かないでください。
* キーは必要な開発者とだけ共有します。
* 漏えいが疑われたら、すぐに再生成します。

## よくある問題

> [accordion] 以前は使えたキーで 401 が返る
>
> キーが再生成されたか、ワークスペースから削除されてキーも削除されました。アカウント設定から現在のキーをコピーするか、新しいキーを生成してください。

> [accordion] すべてのリクエストで 403 が返る
>
> 役割がオーナーまたは編集者であること、ワークスペースのオーナーのサブスクリプションが有効であることを確認してください。アクセスが回復すると、キーはすぐにまた使えるようになります。

> [accordion] 404 "This endpoint is not available." が返る
>
> API はベータ版で、あなたのワークスペースではまだ有効になっていません。

> [accordion] API の設定が表示されない
>
> API の設定は、ワークスペースのオーナーと編集者にのみ、API が有効なワークスペースでのみ表示されます。

## 次のステップ

> [card] [API の概要](https://docs.getqr.com/ja/api/introduction.md)

> [card] [エラー](https://docs.getqr.com/ja/api/errors.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.