AWS パートナーセントラル API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、 AWS パートナーセントラル API リファレンスを参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

セットアップと認証

AWS Partner Central API でのセットアップと認証には 3 つのステップがあります。プロセスの概要を次に示します。

AWS アカウントを Partner Central にリンクする

AWS アカウントを Partner Central にリンクすることは、 API を使用するための前提条件です。詳細については、AWS「Partner Central アカウントとAWS Marketplace販売者アカウントのリンク」を参照してください。アライアンスリーダーまたはクラウド管理者のアクセス許可を持つアカウントで Partner Central にサインインし、 Account Linkingセクションに移動して、プロンプトに従う必要があります。

IAM の設定

AWS Partner Central API を使用するには、(AWS Identity and Access Management IAM) ロールまたは IAM ユーザーが必要です。詳細については、「IAM はいつ使用できますか?」を参照してください。このAWS アカウントガイドの「IAM ロールの作成」および「IAM ユーザーの作成」の手順に従います。Partner Central にリンクされたAWS Marketplace Seller アカウントで、この IAM ロール/ユーザーを作成する必要があります。IAM ロール/ユーザーの作成にはコストはかかりません。

AWS Marketplaceオファーの管理

AWS Marketplaceオファーを管理し、オポチュニティにリンクするには、パートナーは Catalog APIs にアクセスするためのアクセス許可を IAM ロールに付与する必要があります。ロール/ユーザーに aws-marketplace:ListEntitiesや などのアクセス許可があることを確認しますaws-marketplace:SearchAgreements。

API コールの認証

AWS Partner Central API は、認証に Signature Version 4 (SigV4) を使用します。実装方法は次のとおりです。

AWS SDK の使用

AWS SDKsを自動的に処理します。AWS認証情報を入力すると、SDK が残りを行います。

AWS SDK を使用しない認証

選択したプログラミング言語でAWS SDK を使用できない場合、認証には正規リクエストを手動で作成し、リクエストに署名し、セッショントークンを処理します。SigV4 署名を使用するための包括的なガイダンスAWSを提供します。ただし、手動リクエスト署名を使用すると複雑さが増し、セキュリティトークンを慎重に管理する必要があるため、AWS SDK を使用することをお勧めします。

awsJson1_0 プロトコルのすべてのリクエストは、次のヘッダーを使用して HTTP "POST" メソッドを使用してルート URL (/) に送信する必要があります。

必要なヘッダー

awsJson1_0 プロトコルのすべての API リクエストは、次のヘッダーを使用して HTTP "POST" メソッドを使用してルート URL (/) に送信する必要があります。

カスタム user-agent を使用した通話の署名

AWS Partner Central に API リクエストを行うときは、クライアントアプリケーションのソースAWSの特定、使用状況のモニタリング、パフォーマンスの監査に役立つ X-Amzn-User-Agentヘッダーを含めることをお勧めします。 はこのヘッダーAWSを使用して、呼び出しを行うクライアントアプリケーションのタイプを区別し、さまざまなクライアント実装の成功率に関するインサイトを収集します。

カスタムユーザーエージェントヘッダー

ヘッダー名: X-Amzn-User-Agent

目的: API リクエストを行うクライアントのタイプを区別し、インタラクションのソースを分類します。

形式: {Integrator}|{Product}

値の例: AWS|AWS Partner CRM Connector

すべてのリクエストにこのヘッダーを含めるとAWS、 はリクエストパターンを分析し、統合を追跡し、さまざまなクライアントシステムの API エクスペリエンスを向上させることができます。

SDKs

SDK 呼び出しに X-Amzn-User-Agentヘッダーを含めるには、API 呼び出しを行う前にクライアントリクエストの動作を変更できます。AWS SDK for Python (Boto3) を使用した API の販売例を以下に示します。

import boto3

# Define service and endpoint details
service_name = "partnercentral-selling"
endpoint_url = "https://partnercentral-selling.us-east-1.api.aws"

# Create a boto3 client for Partner Central
partner_central_client = boto3.client(
service_name=service_name,
='us-east-1',
endpoint_url=endpoint_url
)

# Function to add the custom User-Agent header

def add_version_header(params, **kwargs):
params["headers"]['X-Amzn-User-Agent'] = 'AWS|AWS Partner CRM Connector'

# Register the event to modify the request before the call is made
partner_central_client.meta.events.register(
f'before-call.{service_name}.*', add_version_header
)

# Now, whenever an API call is made using this client, the custom User-Agent header will be included

この例では、Boto3 SDK にイベントを登録して、すべての API リクエストに X-Amzn-User-Agentヘッダーを自動的に追加する方法を示します。他のAWS SDKs には、それぞれのリクエストインターセプションメカニズムを変更することで、同じアプローチを適用できます。