/v1 のすべてのオペレーションをリソースごとにグループ化して収録しており、認証はあらかじめ設定されています。
ダウンロード
ダウンロードリンクをクリックすると、ファイルが提供される前に Living Security アカウントでのサインインが求められます。
Living Security API v1 コレクション
/v1 のすべてのオペレーションを収録し、Basic 認証があらかじめ設定された Postman Collection v2.1 です。コレクションの baseUrl は空白です。リクエストを送信する前に、リージョンごとの環境を選択してください。コレクションをダウンロード本番 (US) 環境
baseUrl は https://api.us-east-1.livingsecurity.ai/v1 にあらかじめ設定されています。空の apiKeySecret 変数と contractVersion 変数に値を入力してください。US 本番環境をダウンロード本番 (EU) 環境
baseUrl は https://api.eu-west-1.livingsecurity.ai/v1 にあらかじめ設定されています。空の apiKeySecret 変数と contractVersion 変数に値を入力してください。EU 本番環境をダウンロード環境テンプレート
baseUrl が空白の同じ変数を含む、非本番環境向けのテンプレートです。環境テンプレートをダウンロードPostman での設定
1
ファイルのインポート
Postman で インポート を選択し、コレクションファイルと、組織に対応する本番 (US) 環境または本番 (EU) 環境のファイルをドロップします。リージョンを参照してください。
2
API キーの作成
ダッシュボードで 設定 → Integrations & Developers → Developer Hub を開き、サービスアカウントを作成してから API キーを作成します。キーのシークレットは
lsk_live_ で始まり、一度しか表示されないため、すぐにコピーしてください。詳細は API キーを参照してください。3
シークレットの貼り付け
apiKeySecret 変数を設定します。インポートした環境で設定する方法 (シークレット型の変数であるため推奨) か、コレクションの 変数 タブで設定する方法があります。4
リクエストの送信
インポートしたリージョンごとの環境を選択し、任意のリクエスト (例: 組織 → Retrieve the organization) を開いて 送信 をクリックします。環境を選択するまでは送信しないでください。コレクションの
baseUrl は意図的に空白になっています。認証の事前設定について
コレクションには、コレクションレベルで Basic 認証が設定されており、ユーザー名はapikey、パスワードは {{apiKeySecret}} です。API は Basic 認証のどちらのフィールドでもキーのシークレットを受け付けるため、変数を設定すればそのまま動作します。
Bearer 認証を使用する場合は、コレクションの Authorization タイプを Bearer Token に変更し、トークンとして {{apiKeySecret}} を使用してください。API は同じシークレットをどちらの方式でも受け付けます。
API キーで Bearer ヘッダーを使用する場合、OAuth は必要ありません。OAuth を使用するには、Bearer Token に API キーのシークレットではなく OAuth アクセストークンを設定します。方式の選択については認証を、トークンとクライアントの設定については OAuth クライアント認証情報を参照してください。
契約バージョンヘッダー
すべてのリクエストにはLiving-Security-Version ヘッダーが含まれており、{{contractVersion}} があらかじめ設定され、デフォルトでは無効になっています。無効のままにすると、組織に固定されている契約バージョンが使用されます。有効にすると、リクエストを公開済みの特定バージョンに固定できます。公開されているバージョンについては変更履歴を参照してください。
クエリパラメーターとリクエストボディ
一覧エンドポイントのフィルター (limit、page_token、およびリソース固有のフィルター) は各リクエストに含まれていますが無効になっているため、インポート直後でもすべてのエンドポイントを正常に呼び出せます。必要なものを有効にして値を入力してください。page_token の仕組みについてはページネーションを参照してください。POST オペレーションのリクエストボディには、型に合わせたプレースホルダー値があらかじめ入力されています。
コレクションは、契約が変更されるたびに公開済みの OpenAPI 仕様から再生成されます。最新の状態を保ちたいリクエストは、編集するのではなく、新しいコピーをダウンロードしてください。