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

# Postman コレクション

> 生成された Living Security Public API の Postman コレクションをインポートし、API キーを貼り付けるだけで、数分で /v1 を呼び出せます。

Living Security API v1 の Postman コレクションは、[API v1 リファレンス](/v1-reference/openapi-v1.json)の基盤となっている OpenAPI 仕様から生成されているため、公開されている仕様と常に一致します。`/v1` のすべてのオペレーションをリソースごとにグループ化して収録しており、認証はあらかじめ設定されています。

## ダウンロード

<Info>
  ダウンロードリンクをクリックすると、ファイルが提供される前に Living Security アカウントでのサインインが求められます。
</Info>

<CardGroup cols={1}>
  <Card title="Living Security API v1 コレクション" icon="download">
    `/v1` のすべてのオペレーションを収録し、Basic 認証があらかじめ設定された Postman Collection v2.1 です。コレクションの `baseUrl` は空白です。リクエストを送信する前に、リージョンごとの環境を選択してください。

    <a href="/v1-reference/postman/living-security-api-v1.postman_collection.json" download="living-security-api-v1.postman_collection.json">コレクションをダウンロード</a>
  </Card>

  <Card title="本番 (US) 環境" icon="download">
    `baseUrl` は `https://api.us-east-1.livingsecurity.ai/v1` にあらかじめ設定されています。空の `apiKeySecret` 変数と `contractVersion` 変数に値を入力してください。

    <a href="/v1-reference/postman/living-security-production.postman_environment.json" download="living-security-production.postman_environment.json">US 本番環境をダウンロード</a>
  </Card>

  <Card title="本番 (EU) 環境" icon="download">
    `baseUrl` は `https://api.eu-west-1.livingsecurity.ai/v1` にあらかじめ設定されています。空の `apiKeySecret` 変数と `contractVersion` 変数に値を入力してください。

    <a href="/v1-reference/postman/living-security-production-eu.postman_environment.json" download="living-security-production-eu.postman_environment.json">EU 本番環境をダウンロード</a>
  </Card>

  <Card title="環境テンプレート" icon="download">
    `baseUrl` が空白の同じ変数を含む、非本番環境向けのテンプレートです。

    <a href="/v1-reference/postman/living-security-environment-template.postman_environment.json" download="living-security-environment-template.postman_environment.json">環境テンプレートをダウンロード</a>
  </Card>
</CardGroup>

## Postman での設定

<Steps>
  <Step title="ファイルのインポート">
    Postman で **インポート** を選択し、コレクションファイルと、組織に対応する本番 (US) 環境または本番 (EU) 環境のファイルをドロップします。[リージョン](/ja/developers/v1/regions)を参照してください。
  </Step>

  <Step title="API キーの作成">
    ダッシュボードで **設定 → Integrations & Developers → Developer Hub** を開き、サービスアカウントを作成してから API キーを作成します。キーのシークレットは `lsk_live_` で始まり、一度しか表示されないため、すぐにコピーしてください。詳細は [API キー](/ja/developers/developer-hub/api-keys)を参照してください。
  </Step>

  <Step title="シークレットの貼り付け">
    `apiKeySecret` 変数を設定します。インポートした環境で設定する方法 (シークレット型の変数であるため推奨) か、コレクションの **変数** タブで設定する方法があります。
  </Step>

  <Step title="リクエストの送信">
    インポートしたリージョンごとの環境を選択し、任意のリクエスト (例: **組織 → Retrieve the organization**) を開いて **送信** をクリックします。環境を選択するまでは送信しないでください。コレクションの `baseUrl` は意図的に空白になっています。
  </Step>
</Steps>

## 認証の事前設定について

コレクションには、コレクションレベルで Basic 認証が設定されており、ユーザー名は `apikey`、パスワードは `{{apiKeySecret}}` です。API は Basic 認証のどちらのフィールドでもキーのシークレットを受け付けるため、変数を設定すればそのまま動作します。

Bearer 認証を使用する場合は、コレクションの **Authorization** タイプを **Bearer Token** に変更し、トークンとして `{{apiKeySecret}}` を使用してください。API は同じシークレットをどちらの方式でも受け付けます。

API キーで Bearer ヘッダーを使用する場合、OAuth は必要ありません。OAuth を使用するには、**Bearer Token** に API キーのシークレットではなく OAuth アクセストークンを設定します。方式の選択については[認証](/ja/developers/v1/authentication)を、トークンとクライアントの設定については [OAuth クライアント認証情報](/ja/developers/v1/oauth)を参照してください。

## 契約バージョンヘッダー

すべてのリクエストには `Living-Security-Version` ヘッダーが含まれており、`{{contractVersion}}` があらかじめ設定され、デフォルトでは無効になっています。無効のままにすると、組織に固定されている契約バージョンが使用されます。有効にすると、リクエストを公開済みの特定バージョンに固定できます。公開されているバージョンについては[変更履歴](/ja/developers/v1/changelog)を参照してください。

## クエリパラメーターとリクエストボディ

一覧エンドポイントのフィルター (`limit`、`page_token`、およびリソース固有のフィルター) は各リクエストに含まれていますが無効になっているため、インポート直後でもすべてのエンドポイントを正常に呼び出せます。必要なものを有効にして値を入力してください。`page_token` の仕組みについては[ページネーション](/ja/developers/v1/pagination)を参照してください。`POST` オペレーションのリクエストボディには、型に合わせたプレースホルダー値があらかじめ入力されています。

<Note>
  コレクションは、契約が変更されるたびに公開済みの OpenAPI 仕様から再生成されます。最新の状態を保ちたいリクエストは、編集するのではなく、新しいコピーをダウンロードしてください。
</Note>


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