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

# 認証

> Profound の API キーを作成し、REST API リクエストの認証に使用します

<Info>
  **利用可能なプラン**: Enterprise プラン

  **場所**: 画面左上の組織名メニュー内の Settings > Account > API Keys
</Info>

## 概要

API リクエストを認証するには、API キーが必要です。このキーはリクエストを識別・認可し、許可されたユーザーのみがリソースにアクセスできるようにします。

API キーは、ユーザーアカウントに紐づく個人用アクセストークンです。カテゴリ、リージョン、カテゴリレポートなど、所属している組織のデータへのアクセスを提供します。

## API キーの取得

<Steps>
  <Step title="API キー生成ポータルに移動する">
    1. プラットフォームにサインインします。画面左上の組織名を選択し、**Settings** を選択します。
    2. 左サイドバーの **Account** の下で **API Keys** を選択します。キー生成ポータルと、キーの一覧テーブルが表示されます。
  </Step>

  <Step title="キーを設定して作成する">
    1. **Create API Key** バナーで **key name** を入力し、**Expiration** の期間を選択します。
    2. **Create API Key** を選択してキーを生成します。

    <Note>
      セキュリティ強化のため、キーを再度取得することはできません。先に進む前に、API キーをコピーして安全に保管してください。
    </Note>

    API キーは **API Keys** ページのテーブルに表示されます。このページにはいつでも戻って、キーの確認、有効期限のチェック、既存キーの無効化を行えます。
  </Step>
</Steps>

## 認証方法

リクエストは、以下のいずれかの方法で認証できます。

### ヘッダー認証(推奨)

API キーを `X-API-Key` ヘッダーに含めます。

<CodeGroup>
  ```http Header Method theme={null}
  POST /v1/reports/visibility HTTP/1.1
  Host: api.tryprofound.com
  X-API-Key: your_api_key_here
  Content-Type: application/json
  ```

  ```bash cURL theme={null}
  curl -X POST "https://api.tryprofound.com/v1/reports/visibility" \
    -H "X-API-Key: your_api_key_here" \
    -H "Content-Type: application/json"
  ```
</CodeGroup>

## API キーのスコープと権限

API キーでは、次のデータにアクセスできます。

* **組織データ**: 所属している組織のデータ
* **カテゴリ**: 利用可能なデータカテゴリとそのメタデータ
* **リージョンデータ**: 位置情報に基づく情報とフィルター
* **レポート**: カテゴリに関して生成されたレポートと分析
* **Raw データ**: アクセス可能なカテゴリ内の未加工データ

### キーの所有権

* **キーはユーザー個人に属します**: 各 API キーは、それを作成したユーザーに紐づきます。キーを使用したすべてのリクエストは、他の人が送信した場合でも、そのユーザーによるものとして記録されます。
* **キーは所有者のみが保持します**: Profound は各キーのハッシュのみを保存するため、組織の管理者を含め、作成後にキーを閲覧できる人はいません。
* **アクセスはメンバーシップに従います**: 組織から削除された場合、キー自体は残りますが、その組織のデータにはアクセスできなくなります。キーを完全に無効にするには、**API Keys** ページで無効化してください。

## セキュリティのベストプラクティス

* **キーを非公開に保つ**: API キーは機密情報です。公開したり、バージョン管理にコミットしたりしないでください。パスワードと同様に安全に保管してください。
* **環境変数を使用する**: キーは環境変数または安全な設定ファイルに保存してください。
* **定期的にローテーションする**: セキュリティを強化するため、API キーを定期的にローテーションすることを検討してください。
* **使用状況をモニタリングする**: 不正アクセスを検知するため、API の使用状況を定期的に確認してください。

## 認証エラー

よくある認証エラーとその意味は次のとおりです。

| ステータスコード | エラー | 説明 |
| - | - | - |
| `401 Unauthorized` | 無効な API キー | 指定された API キーが正しくないか、有効期限が切れています |
| `403 Forbidden` | 権限不足 | API キーに、リクエストされたリソースへのアクセス権がありません |
| `429 Too Many Requests` | レート制限超過 | API キーのレート制限を超えました |

## お困りの場合

認証に関する問題が発生した場合は、[サポートにお問い合わせ](mailto:support@tryprofound.com)ください。