View a markdown version of this page

Einrichtung und Authentifizierung - AWS Partner Central

Die AWS Partner Central API-Referenz wurde neu strukturiert. Weitere Informationen zu den unterstützten API-Vorgängen finden Sie in der AWS Partner Central API-Referenz.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Einrichtung und Authentifizierung

Die Einrichtung und Authentifizierung mit der AWS Partner Central-API umfasst drei Schritte. Hier ist ein Überblick über den Prozess:

  1. Verknüpfen Sie Ihr AWS Marketplace Verkäuferkonto mit Partner Central.

  2. Richten Sie Berechtigungen mithilfe von IAM ein.

  3. Authentifizieren Sie Ihre API-Aufrufe mit Signature Version 4 (Sigv4).

Verknüpfen Sie Ihre AWS-Konto mit Partner Central

Die Verknüpfung mit Partner AWS-Konto Central ist eine Voraussetzung für die Nutzung der API. Weitere Informationen finden Sie unter AWS Partner Central-Konten mit AWS Marketplace Verkäuferkonten verknüpfen. Sie müssen sich bei Partner Central mit einem Konto anmelden, das über Alliance-Lead- oder Cloud-Administratorrechte verfügt, zu dem Account Linking Abschnitt navigieren und den Anweisungen folgen.

Einrichten von IAM

Um die AWS Partner Central-API verwenden zu können, benötigen Sie eine AWS Identity and Access Management(IAM-) Rolle oder einen IAM-Benutzer, um Anrufe tätigen zu können. Weitere Informationen finden Sie unter Wann verwende ich IAM? . Folgen Sie dazu den Schritten zum Erstellen von IAM-Rollen und Erstellen eines IAM-Benutzers in Ihren AWS-Konto Anleitungen. Sie müssen dieses IAM Role/User in Ihrem Central-linked AWS Marketplace Partnerverkäuferkonto erstellen. Für die role/user IAM-Erstellung fallen keine Kosten an.

  1. Erstellen Sie ein IAM Role/User

    Melden Sie sich beim an AWS Management Console, navigieren Sie zum IAM-Dienst und folgen Sie den Schritten, um eine IAM-Rolle oder einen IAM-Benutzer zu erstellen.

  2. Richtlinien zuweisen:

    Hängen Sie nach Bedarf verwaltete Richtlinien an oder erstellen Sie benutzerdefinierte Richtlinien. Um Berechtigungen zu ändern oder zu erweitern, wenden Sie zusätzliche Richtlinien auf die IAM-Rolle an, anstatt den Inhalt zu kopieren und AWSPartnerCentralOpportunityManagement mit anderen Berechtigungen zu kombinieren. Vermeiden Sie es, verwaltete Richtlinien zu duplizieren, da Sie dadurch nicht automatisch Zugriff auf neue Funktionen erhalten, sobald diese veröffentlicht werden, und Sie Ihre Richtlinien in future manuell aktualisieren müssen. Weitere Informationen zu Zugriffsrichtlinien finden Sie in der Dokumentation zur Zugriffskontrolle.

Verwalten AWS Marketplace Angebote

Um AWS Marketplace Angebote zu verwalten und sie mit Opportunities zu verknüpfen, müssen Partner der IAM-Rolle die Erlaubnis erteilen, auf Katalog-APIs zuzugreifen. Stellen Sie sicher, dass der role/user über Berechtigungen wie aws-marketplace:ListEntities und aws-marketplace:SearchAgreements verfügt.

Authentifizierung von API-Aufrufen

AWS Die Partner Central API verwendet Signature Version 4 (Sigv4) für die Authentifizierung. So implementieren Sie es:

Verwendung der AWS SDK

AWS SDKs kümmern sich automatisch um das Signieren von Anfragen. Geben Sie Ihre AWS Anmeldeinformationen ein und das SDK erledigt den Rest.

  1. Informationen zu Java finden Sie unter Bereitstellen temporärer Anmeldeinformationen für das AWS SDK for Java.

  2. Für Python (Boto3) siehe Credentials.

  3. Informationen zu JavaScript (Node.js) finden Sie unter Anmeldeinformationen einrichten in. Node.js

  4. Für .NET siehe Auflösung von Anmeldeinformationen und Profilen.

  5. Weitere Programmiersprachen und weitere Beispiele finden Sie unter Tools to Build On AWS.

Authentifizierung ohne Verwendung von AWS SDK

Wenn für die von Ihnen gewählte Programmiersprache kein AWS SDK verfügbar ist, umfasst die Authentifizierung das manuelle Erstellen einer kanonischen Anfrage, das Signieren der Anfrage und das Verarbeiten der Sitzungstoken.AWS bietet umfassende Anleitungen zur Verwendung der SigV4-Signatur. Bitte beachten Sie jedoch, dass die Verwendung des AWS SDK empfohlen wird, da das manuelle Signieren von Anfragen die Komplexität erhöht und eine sorgfältige Verwaltung der Sicherheitstoken erfordert.

Jede Anfrage für das awsjson1_0-Protokoll MUSS mithilfe der HTTP- „POST“ -Methode unter Verwendung der folgenden Header an die Root-URL (/) gesendet werden.

Erforderliche Header

Jede API-Anfrage für das awsjson1_0-Protokoll MUSS mithilfe der HTTP- „POST“ -Methode unter Verwendung der folgenden Header an die Root-URL (/) gesendet werden.

Header Erforderlich Description
Content-Type true Dieser Header hat einen statischen Wert von. application/x-amz-json-1.0
Content-Length true Der durch RFC 9110 #section -8.6 definierte Content-Length Standard-Header.
X-Amz-Target gilt für Anfragen Der Wert für den Betrieb CreatePartner des Dienstes PartnerCentralAccount ist beispielsweisePartnerCentralAccount.CreatePartner.

Signieren Sie Ihre Anrufe mit einem benutzerdefinierten Benutzeragenten

Wenn Sie API-Anfragen an AWS Partner Central stellen, empfehlen wir, den X-Amzn-User-Agent Header anzugeben, um die Quelle der Client-Anwendung zu AWS identifizieren, die Nutzung zu überwachen und die Leistung zu überprüfen.AWS verwendet diesen Header, um den Typ der Client-Anwendung zu unterscheiden, die den Anruf tätigt, und um Erkenntnisse über die Erfolgsquote verschiedener Client-Implementierungen zu gewinnen.

Benutzerdefinierter User-Agent-Header

Name der Kopfzeile: X-Amzn-User-Agent

Zweck: Unterscheidet den Typ des Clients, der die API-Anfrage stellt, und kategorisiert die Quelle der Interaktion.

Format: {Integrator}|{Product}

Beispielwert: AWS|AWS Partner CRM Connector

Wenn Sie diesen Header in jede Anfrage aufnehmen AWS, können Sie Anforderungsmuster analysieren, Integrationen verfolgen und das API-Erlebnis für verschiedene Clientsysteme verbessern.

Verwendung benutzerdefinierter Header in SDKs

Um den X-Amzn-User-Agent Header in SDK-Aufrufe einzubeziehen, können Sie das Verhalten der Client-Anfrage ändern, bevor Sie den API-Aufruf ausführen. Im Folgenden finden Sie ein Beispiel für eine Verkaufs-API mit dem AWS SDK for Python (Boto3):

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

Dieses Beispiel zeigt, wie ein Ereignis im Boto3-SDK registriert wird, um den X-Amzn-User-Agent Header automatisch an jede API-Anfrage anzuhängen. Derselbe Ansatz kann auf andere AWS SDKs angewendet werden, indem ihre jeweiligen Mechanismen zum Abfangen von Anfragen geändert werden.

Anmerkung

Das X-Amzn-User-Agent Header-Format wurde vereinfacht. Wir empfehlen, das neue Format zu verwenden. Das vorherige Format (CompanyName|ProductName|CRMName|ProductVersion) wird aus Gründen der Abwärtskompatibilität weiterhin unterstützt. Bestehende Integrationen funktionieren weiterhin ohne Änderungen.