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.

Verkaufen Sie Ihre API Gateway Gateway-APIs über AWS Marketplace

Nachdem Sie Ihre APIs erstellt, getestet und bereitgestellt haben, können Sie sie in einem API Gateway Gateway-Nutzungsplan verpacken und den Plan als SaaS-Produkt (Software as a Service) verkaufen AWS Marketplace. API-Käufern, die Ihr Produktangebot abonnieren, wird auf der AWS Marketplace Grundlage der Anzahl der Anfragen an den Nutzungsplan abgerechnet.

Um Ihre APIs weiterverkaufen zu können AWS Marketplace, müssen Sie den Vertriebskanal für die Integration AWS Marketplace mit API Gateway einrichten. Im Allgemeinen beinhaltet dies, dass Sie Ihr Produkt anbieten AWS Marketplace, eine IAM-Rolle mit entsprechenden Richtlinien einrichten, damit API Gateway Nutzungsdaten an diese senden kann AWS Marketplace, ein AWS Marketplace Produkt einem API Gateway Gateway-Nutzungsplan zuordnen und einem AWS Marketplace Käufer einen API-Gateway-API-Schlüssel zuordnen. Details dazu finden Sie in den folgenden Abschnitten.

Weitere Informationen zum Verkauf Ihrer API als SaaS-Produkt finden Sie im AWS Marketplace Benutzerhandbuch. AWS Marketplace

Initialisierung der AWS Marketplace -Integration mit API Gateway

Die folgenden Aufgaben betreffen die einmalige Initialisierung der AWS Marketplace Integration mit API Gateway, sodass Sie Ihre APIs als SaaS-Produkt verkaufen können.

Bieten Sie ein Produkt auf AWS Marketplace

Übermitteln Sie für die Eintragung Ihres Nutzungsplans als SaaS-Produkt ein Produktladeformular über AWS Marketplace. Das Produkt muss eine Dimension mit dem Namen apigateway vom Typ requests enthalten. Diese Dimension definiert die price-per-request und wird von API Gateway verwendet, um Anfragen an Ihre APIs zu messen.

Erstellen der Messungsrolle

Erstellen Sie eine IAM-Rolle mit dem Namen ApiGatewayMarketplaceMeteringRole und der folgenden Ausführungsrichtlinie und Vertrauensrichtlinie. Diese Rolle ermöglicht es API Gateway, in Ihrem Namen Nutzungsmetriken AWS Marketplace an zu senden.

Ausführungsrichtlinie der Messungsrolle

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": [
        "aws-marketplace:BatchMeterUsage",
        "aws-marketplace:ResolveCustomer"
      ],
      "Resource": "*",
      "Effect": "Allow"
    }
  ]
}

Vertrauensbeziehungsrichtlinie der Messungsrolle

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "apigateway.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

Verknüpfen Sie den Nutzungsplan mit dem AWS Marketplace Produkt

Wenn Sie ein Produkt anbieten AWS Marketplace, erhalten Sie einen AWS Marketplace Produktcode. Um API Gateway zu integrieren AWS Marketplace, verknüpfen Sie Ihren Nutzungsplan mit dem AWS Marketplace Produktcode. Sie aktivieren die Zuordnung, indem Sie das productCodeFeld UsagePlan des API-Gateways auf Ihren AWS Marketplace Produktcode setzen, indem Sie die API Gateway-Konsole, die API Gateway Gateway-REST-API, die AWS CLI für API Gateway oder das AWS SDK für API Gateway verwenden. Das folgende Codebeispiel verwendet die API Gateway-REST-API:

PATCH /usageplans/USAGE_PLAN_ID
Host: apigateway.region.amazonaws.com
Authorization: ...

{
    "patchOperations" : [{
        "path" : "/productCode",
        "value" : "MARKETPLACE_PRODUCT_CODE",
        "op" : "replace"
    }]
}

Verarbeiten von Kundenabonnements eines Nutzungsplans

Die folgenden Aufgaben werden von Ihrer Entwicklerportalanwendung übernommen.

Wenn ein Kunde Ihr Produkt abonniert AWS Marketplace, AWS Marketplace leitet eine POST Anfrage an die SaaS-Abonnement-URL weiter, unter der Sie Ihr Produkt angeboten haben. AWS Marketplace Die POST-Anforderung enthält einen x-amzn-marketplace-token-Parameter mit Käuferinformationen. Befolgen Sie die Anweisungen unter Onboarding für SaaS-Kunden, um diese Umleitung in Ihrer Entwicklerportalanwendung zu verarbeiten.

Wenn Sie auf die Abonnementanfrage eines Kunden antworten, wird eine subscribe-success Benachrichtigung zu einem Amazon SNS SNS-Thema AWS Marketplace gesendet, das Sie abonnieren können. (Informationen finden Sie unter Onboarding für SaaS-Kunden). Um die Abonnementanfrage des Kunden anzunehmen, bearbeiten Sie die subscribe-success Benachrichtigung, indem Sie einen AWS Marketplace API-Gateway-API-Schlüssel für den Kunden erstellen oder abrufen, den vom Kunden bereitgestellten customerId API-Schlüsseln zuordnen und den API-Schlüssel dann zu Ihrem Nutzungsplan hinzufügen.

Wenn die Abonnementanforderung des Kunden abgeschlossen ist, sollte der Kunde in der Entwicklerportalanwendung mit dem zugeordneten API-Schlüssel angezeigt werden und wird informiert, dass der API-Schlüssel im Header x-api-key von Anforderungen an die APIs enthalten sein muss.

Wenn ein Kunde ein Abonnement für einen Nutzungsplan kündigt, AWS Marketplace sendet er eine unsubscribe-success Benachrichtigung zum Thema SNS. Zum Abschließen der Abonnementkündigung des Kunden verarbeiten Sie die unsubscribe-success-Benachrichtigung, indem Sie die API-Schlüssel des Kunden aus dem Nutzungsplan entfernen.

Autorisieren eines Kunden für den Zugriff auf den Nutzungsplan

Verwenden Sie zum Autorisieren des Zugriffs eines Kunden auf Ihren Nutzungsplan die API Gateway-API, um einen API-Schlüssel abzurufen oder zu erstellen, und fügen Sie dem Nutzungsplan den API-Schlüssel hinzu.

Das folgende Beispiel zeigt, wie die API Gateway REST API aufgerufen wird, um einen neuen API-Schlüssel mit einem bestimmten AWS Marketplace customerId Wert (MARKETPLACE_CUSTOMER_ID) zu erstellen.

POST apikeys HTTP/1.1
Host: apigateway.region.amazonaws.com
Authorization: ...

{
  "name" : "my_api_key",
  "description" : "My API key",
  "enabled" : "false",
  "stageKeys" : [ {
    "restApiId" : "uycll6xg9a",
    "stageName" : "prod"
  } ],
  "customerId" : "MARKETPLACE_CUSTOMER_ID"
}

Das folgende Beispiel zeigt, wie Sie einen API-Schlüssel mit einem bestimmten AWS Marketplace customerId Wert (MARKETPLACE_CUSTOMER_ID) abrufen.

GET apikeys?customerId=MARKETPLACE_CUSTOMER_ID HTTP/1.1
Host: apigateway.region.amazonaws.com
Authorization: ...

Erstellen Sie zum Hinzufügen eines API-Schlüssels zu einem Nutzungsplan einen UsagePlanKey mit dem API-Schlüssel für den entsprechenden Nutzungsplan. Im folgenden Beispiel wird gezeigt, wie dies über die API Gateway-REST-API durchgeführt wird, wobei n371pt die Nutzungsplan-ID und q5ugs7qjjh eine Beispiel-API-keyId ist, die in den vorhergehenden Beispielen zurückgegeben wurde.

POST /usageplans/n371pt/keys HTTP/1.1
Host: apigateway.region.amazonaws.com
Authorization: ...

{
    "keyId": "q5ugs7qjjh",
    "keyType": "API_KEY"
}

Verknüpfen eines Kunden mit einem API-Schlüssel

Sie müssen das customerId Feld mit der ApiKeyKunden-ID des AWS Marketplace Kunden aktualisieren. Auf diese Weise wird der API-Schlüssel mit dem AWS Marketplace -Kunden verknüpft, was die Messung und Abrechnung dieses Käufers ermöglicht. Im folgenden Codebeispiel wird die API Gateway-REST-API aufgerufen, um dies durchzuführen.

PATCH /apikeys/q5ugs7qjjh
Host: apigateway.region.amazonaws.com
Authorization: ...
        
{
    "patchOperations" : [{
        "path" : "/customerId",
        "value" : "MARKETPLACE_CUSTOMER_ID",
        "op" : "replace"
    }]
}