スタート ガイド

このページでは、デベロッパーが Cloud de Confiance by S3NS API の使用を開始する方法について説明します。

Cloud de Confiance API を初めて使用する場合は、このガイドの手順に沿って curl コマンドを使用して API を呼び出すことができます。curl コマンドを使用することで、アプリケーションを開発する前に API を試すことができます。

S3NS プロジェクトの作成

Cloud de Confiance API を使用するには、ユーザー アカウント（S3NS アカウントまたは外部 ID プロバイダのアカウント）とS3NS プロジェクトが必要です。プロジェクトはデベロッパー アカウントに相当します。これは、 Cloud de Confiance リソースのリソース コンテナとして機能します。また、 Cloud de Confiance by S3NS サービスの使用に対して分離境界を提供するため、プロジェクト レベルで割り当て制限と課金を別々に管理できます。使用状況テレメトリーとダッシュボードもプロジェクトごとにグループ化されます。プロジェクトがない場合は、Cloud de Confiance コンソールを使用して作成できます。

プロジェクトでは、API キー、OAuth クライアント、サービス アカウント、Compute Engine VM、Cloud Storage バケット、BigQuery データセットなど、幅広いリソースを所有できます。アプリケーションが Cloud de Confiance API を呼び出すとき、アプリケーション認証情報を所有するプロジェクトはクライアント プロジェクトと呼ばれ、ターゲット リソースを所有するプロジェクトはリソース プロジェクトと呼ばれます。API リクエストが複数のリソースにアクセスする場合、複数のリソース プロジェクトが含まれます。

なんらかの理由で Cloud de Confiance の使用を停止する場合は、Cloud de Confiance コンソールを使用してプロジェクトを削除できます。プロジェクトとプロジェクト内のすべてのリソースは、保持期間の後に削除されます。データのタイプごとに保持期間が異なることに留意してください。

API の探索

Cloud de Confiance API を使用する前に、 Cloud de Confiance コンソールの API ライブラリを使用して、使用可能なCloud de Confiance API を確認し、ビジネスニーズに最適な API を特定する必要があります。

API を有効にしています

一部の Cloud de Confiance API はデフォルトで有効になっています。デフォルトでは有効になっていない Cloud de ConfianceAPI を使用するには、プロジェクトでそれを有効にする必要があります。クライアント プロジェクトやリソース プロジェクトなど、アプリケーションで使用するサービスやプロジェクトによっては、複数のプロジェクトで API を有効にする必要がある場合があります。他の API に依存する API を有効にすると、依存先の API も同時に有効になります。

API を有効にするには、API の利用規約と請求の責任に同意する必要があります。API を有効にするには、プロジェクトに対する権限 serviceusage.services.enable が必要です。詳細については、Service Usage のアクセス制御をご覧ください。

コンソールを使用してプロジェクトの API を有効にするには、次の手順を行います。

  1. Cloud de Confiance コンソールの API ライブラリに移動します。
  2. プロジェクト リストから、使用するプロジェクトを選択します。
  3. API ライブラリで、有効にする API を選択します。API を検索する場合は検索フィールドやフィルタを使用します。
  4. [API] ページで、[有効にする] をクリックします。

同じページからプロジェクトの API を無効にすると、不正使用や誤課金を避けることができます。gcloud CLI と Service Usage API を使用して、Cloud APIs を有効または無効にすることもできます。

gcloud services enable pubsub.googleapis.com
gcloud services disable pubsub.googleapis.com

課金の有効化

Cloud APIs の中には、使用量に応じて課金されるものがあります。そのような API は、プロジェクトで課金を有効にした後、使い始める必要があります。プロジェクトでの API 使用分は、プロジェクトに関連付けられた請求先アカウントに課金されます。

API に対する認証

API に対して認証する方法は、開発環境や、API でサポートされている認証方法によって異なります。

さまざまな環境で使用するアプリケーションのデフォルト認証情報を設定することが、最も一般的なアプローチであり、ほとんどのアプリケーションで推奨されます。API が API キーをサポートしている場合は、別の選択肢としてそれを使用できます。エンドユーザーが所有する Cloud リソースにアプリケーションがアクセスする必要がある場合は、OAuth 2.0 クライアント ID を作成して認証ライブラリを使用します。

認証に関する一般的な情報については、Google での認証をご覧ください。

アプリケーションの構築

Cloud API を使用してアプリケーションを構築する場合は、可能であれば Cloud de Confiance クライアント ライブラリを使用することをおすすめします。クライアント ライブラリは、認証、エラー処理、再試行、ペイロード検証などの一般的な API 機能を処理します。初期化中にアプリケーションの認証情報をクライアント ライブラリに渡す必要があります。これにより、クライアント ライブラリでアプリケーションの代わりにCloud de Confiance API を呼び出すことが可能です。

詳細