Die AWS Marketplace API-Referenz wurde neu strukturiert. Weitere Informationen zu den unterstützten API-Vorgängen finden Sie in der AWS Marketplace 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.

Arbeiten Sie als Käufer mit der Agreement API

Eine Vereinbarung ist ein Dokument, das zwei Parteien bindet, darunter den Anbieter und den Akzeptierenden (in der Regel der Käufer), und das die zwischen ihnen geltenden Bedingungen und Konditionen festlegt.

Der Käufer erstellt ein AgreementRequest, wodurch ein Angebot generiert wird. Dieses Angebot enthält alle relevanten Informationen, z. B. die geschätzten Kosten, die während der Laufzeit des Vertrags anfallen werden, was für die Kaufentscheidung des Käufers von entscheidender Bedeutung ist. Wenn der Käufer mit dem Angebot zufrieden ist, kann er es annehmen, AgreementRequest bevor es abläuft. Die Vereinbarung entsteht mit der Annahme der AgreementRequest. Während dieses Vorgangs kann der Käuferadministrator oder die Käuferperson die Bestellung den Gebühren zuordnen. Schließlich wird dem Käufer auf der Grundlage der Bedingungen der aktuellen Vereinbarung eine Rechnung ausgestellt und ihm wird eine Lizenz zur Nutzung des Produkts erteilt.

Voraussetzungen: Entdecken Sie Produkte und Angebote

Bevor Sie eine Vereinbarung erstellen, verwenden Sie die AWS Marketplace Discovery-API, um das Produkt zu ermitteln und die für die Erstellung einer Vereinbarung erforderlichen agreementProposalIdpricingModel, und Begriffsdetails abzurufenCreateAgreementRequest.

Ausführliche Informationen zum Entdecken von Produkten und zur Preisgestaltung finden Sie unterEntdecken Sie Produkte und Preise.

Ein Akzeptor kann mit dieser API die folgenden Aufgaben ausführen:

Generieren Sie ein Angebot

Verwenden SieCreateAgreementRequest, um ein Angebot zu generieren. Sie müssen die folgenden Informationen angeben:

response = client.create_agreement_request(
    agreementProposalIdentifier='at-edhtjnbilupjv3xqbphtom77y',
    intent='NEW',
    requestedTerms=[
        {'id': 'term-legal-abc123'},
        {'id': 'term-validity-def456'},
        {
            'id': 'term-configurable-pricing-789',
            'configuration': {
                'configurableUpfrontPricingTermConfiguration': {
                    'selectorValue': 'P12M',
                    'dimensions': [
                        {'dimensionKey': 'Users', 'dimensionValue': 50}
                    ]
                }
            }
        },
        {
            'id': 'term-renewal-012',
            'configuration': {
                'renewalTermConfiguration': {'enableAutoRenew': True}
            }
        }
    ]
)

print(f"Agreement Request ID: {response['agreementRequestId']}")
for charge in response['chargeSummary']['expectedCharges']:
    print(f"  Charge ID: {charge['id']}, Amount: ${charge['amount']}")

RequestedTerms erstellen

Um zu konstruierenrequestedTerms, müssen Sie zwei Dinge bestimmen:

Erforderliche Bedingungen je nach Preismodell

Das pricingModel.PricingModel Feld in der GetOfferAntwort bestimmt, welche Begriffe in Ihrem enthalten sein müssenCreateAgreementRequest.

Die folgenden Bedingungen müssen in jeder Vereinbarung enthalten sein, sofern sie im Angebot enthalten sind: LegalTermSupportTerm,ValidityTerm, undRenewalTerm.

VERTRAG

Alle von zurückgegebenen Bedingungen müssen in einem einzigen Dokument zusammengefasst GetOfferTermswerdenCreateAgreementRequest.

VERWENDUNG

Die Erstellung der Vereinbarung hängt von den im Angebot enthaltenen Bedingungen ab:

BYOL

Akzeptieren ByolPricingTerm Sie zusammen mit den verbindlichen Bedingungen.

Begriffskonfigurationen

Für die meisten Begriffe ist nur die Angabe id von erforderlich GetOfferTerms. Für die folgenden Begriffstypen ist zusätzlich ein vom Käufer configuration bereitgestelltes Dokument erforderlich: id

ConfigurableUpfrontPricingTermConfiguration

Verwenden Sie das folgende Beispiel, um die benötigten Werte für zu findenConfigurableUpfrontPricingTermConfiguration.

Beispiel für GetOfferTerms eine Antwort:

{
  "offerTerms": [
    {
      "configurableUpfrontPricingTerm": {
        "id": "term-34dfb665ebd38eb2d0269a4af454c4f33cd90292ecc7b0f71058175594f67394",
        "currencyCode": "USD",
        "rateCards": [
          {
            "constraints": {
              "multipleDimensionSelection": "Allowed",
              "quantityConfiguration": "Allowed"
            },
            "selector": {
              "type": "Duration",
              "value": "P1M"
            },
            "rateCard": [
              {
                "dimensionKey": "BasicService",
                "displayName": "Basic Service",
                "price": "0",
                "unit": "Units"
              },
              {
                "dimensionKey": "PremiumService",
                "displayName": "Premium Service",
                "price": "0",
                "unit": "Units"
              }
            ]
          }
        ],
        "type": "ConfigurableUpfrontPricingTerm"
      }
    }
  ]
}

RequestedTermBeispielnutzlast fürConfigurableUpfrontPricingTerm:

{
  "id": "term-43ab7a2445f89dfcb7e1a6a81c92fe08c124125ffad126bea5e5b7915c065166",
  "configuration": {
    "configurableUpfrontPricingTermConfiguration": {
      "selectorValue": "P12M",
      "dimensions": [
        {
          "dimensionKey": "AdminUsers",
          "dimensionValue": 5
        },
        {
          "dimensionKey": "ReadOnlyUsers",
          "dimensionValue": 10
        }
      ]
    }
  }
}

RenewalTermConfiguration

Beispiel für eine RequestedTerm Payload für: RenewalTerm

{
  "id": "term-ffcc0100ce0c5468426dc07d0b05cff09ab8447640108d9c95ce1591f0949738",
  "configuration": {
    "renewalTermConfiguration": {
      "enableAutoRenew": false
    }
  }
}

VariablePaymentTermConfiguration

Beispiel für eine RequestedTerm Nutzlast fürVariablePaymentTerm:

{
  "id": "term-9ab34376c51cd5b4dc995aa0f410b657d58bd577b3f09b34d38afb6964aaaf12",
  "configuration": {
    "variablePaymentTermConfiguration": {
      "paymentRequestApprovalStrategy": "AUTO_APPROVE_ON_EXPIRATION",
      "expirationDuration": "P10D"
    }
  }
}

Nehmen Sie ein Angebot an

Generieren Sie zunächst ein Angebot, wie unter beschriebenGenerieren Sie ein Angebot. Verwenden Sie dann, AcceptAgreementRequest um das Angebot anzunehmen und die Vereinbarung zu erstellen. Sie müssen anrufen, AcceptAgreementRequest bevor die Vertragsanfrage abläuft. Sie können bei der Annahme optional eine Bestellnummer zuordnen.

# Use chargeId from CreateAgreementRequest response
response = client.accept_agreement_request(
    agreementRequestId='agrq-abc123',
    purchaseOrders=[
        {
            'chargeId': 'charge-xyz',  # From chargeSummary.expectedCharges[].id
            'purchaseOrderReference': 'PO-2024-001'
        }
    ]
)

print(f"Agreement ID: {response['agreementId']}")

Ersetzen Sie eine bestehende Vereinbarung

Konstruieren Sie eine CreateAgreementRequest wie unter beschriebenGenerieren Sie ein Angebot, legen Sie jedoch fest, dass sie ersetzt werden intent soll, REPLACE und legen Sie die Vereinbarung sourceAgreementIdentifier bei. Rufen Sie dann AcceptAgreementRequest an, um den Austausch abzuschließen.

response = client.create_agreement_request(
    agreementProposalIdentifier='at-edhtjnbilupjv3xqbphtom77y',
    intent='REPLACE',
    sourceAgreementIdentifier='agmt-existing123'
)

print(f"Agreement Request ID: {response['agreementRequestId']}")

Ändern Sie eine bestehende Vereinbarung

Um die Laufzeitkonfiguration in einer bestehenden Vereinbarung zu ändern, setzen Sie intent auf AMEND und geben Sie ansourceAgreementIdentifier. Im Gegensatz zu einer neuen Vereinbarung agreementProposalIdentifier ist keine erforderlich. Geben Sie nur die Begriffe an, deren Konfiguration Sie ändern möchten. Rufen Sie dann AcceptAgreementRequest an, um die Änderung anzuwenden.

response = client.create_agreement_request(
    intent='AMEND',
    sourceAgreementIdentifier='agmt-existing123',
    requestedTerms=[
        {
            'id': 'term-configurable-pricing-789',
            'configuration': {
                'configurableUpfrontPricingTermConfiguration': {
                    'selectorValue': 'P12M',
                    'dimensions': [
                        {'dimensionKey': 'Users', 'dimensionValue': 100}
                    ]
                }
            }
        }
    ]
)

print(f"Agreement Request ID: {response['agreementRequestId']}")

Automatische Verlängerung aktivieren oder deaktivieren

Verwenden Sie es CreateAgreementRequest mit der AMEND Absicht, die automatische Verlängerung umzuschalten.

response = client.create_agreement_request(
    intent='AMEND',
    sourceAgreementIdentifier='agmt-existing123',
    requestedTerms=[
        {
            'id': 'term-renewal-456',
            'configuration': {
                'renewalTermConfiguration': {'enableAutoRenew': True}
            }
        }
    ]
)

print(f"Agreement Request ID: {response['agreementRequestId']}")

Kündigen Sie eine Vereinbarung

Wird verwendetCancelAgreement, um eine Nutzungsvereinbarung zu kündigen. Bei anderen Vertragsarten muss sich der Käufer an den Verkäufer wenden, um die Kündigung einzuleiten.

client.cancel_agreement(
    agreementId='agmt-abc123'
)

Suchen Sie nach Verträgen

Verwenden Sie diese OptionSearchAgreements, um in allen Vereinbarungen zu suchen, an denen Sie als Akzeptor teilnehmen. Die Suche gibt eine Liste von Vereinbarungen mit grundlegenden Vertragsinformationen zurück.

response = client.search_agreements(
    catalog='AWSMarketplace',
    filters=[
        {'name': 'PartyType', 'values': ['Acceptor']},
        {'name': 'AgreementType', 'values': ['PurchaseAgreement']},
        {'name': 'Status', 'values': ['ACTIVE']}
    ]
)

for agmt in response['agreementViewSummaries']:
    print(f"  {agmt['agreementId']}: {agmt['status']}")

Beschreiben Sie eine Vereinbarung

Dient DescribeAgreement zum Anzeigen von Details zu einer Vereinbarung, z. B. dem Antragsteller, dem Annahmedatum, dem Startdatum und dem Enddatum.

response = client.describe_agreement(
    agreementId='agmt-abc123'
)

print(f"Status: {response['status']}")
print(f"Start: {response['startTime']}")
print(f"End: {response['endTime']}")

Vereinbarungsbedingungen abrufen

Verwenden Sie diese OptionGetAgreementTerms, um Einzelheiten zu den Bedingungen einer Vereinbarung zu erhalten, an der Sie als Akzeptor teilnehmen.

response = client.get_agreement_terms(
    agreementId='agmt-abc123'
)

for term in response['acceptedTerms']:
    print(f"  Term: {term}")

Holen Sie sich die Rechte an der Vereinbarung

Verwenden Sie diese OptionGetAgreementEntitlements, um sich einen Überblick über den Status und die Einzelheiten der mit Ihrer Vereinbarung verbundenen Rechte auf Vertragsebene zu verschaffen.

response = client.get_agreement_entitlements(
    agreementId='agmt-abc123'
)

for ent in response['agreementEntitlements']:
    print(f"  {ent['resource']}: {ent['status']}")

Holen Sie sich ein Registrierungstoken

Verwenden SieGetAgreementEntitlements, um ein Registrierungstoken zu erhalten. Dieses kurzlebige Token (gültig für 30 Minuten) wird von den Akzeptoren benötigt, um ein Konto bei den Antragstellern einzurichten. Gilt derzeit nur für SaaS-Kaufverträge.

response = client.get_agreement_entitlements(
    agreementId='agmt-abc123'
)

for ent in response['agreementEntitlements']:
    if 'registrationToken' in ent:
        print(f"Registration Token: {ent['registrationToken']}")
        # Token is valid for 30 minutes

Gebühren für die Vereinbarung auflisten

Verwenden Sie diese OptionListAgreementCharges, um Gebühren und Bestelldetails im Zusammenhang mit Ihrer Vereinbarung einzusehen.

response = client.list_agreement_charges(
    agreementId='agmt-abc123'
)

for charge in response['items']:
    print(f"  {charge['id']} (rev {charge['revision']}): ${charge['amount']}")
    print(f"  PO: {charge.get('purchaseOrderReference', 'N/A')}")

Bestellungen aktualisieren

Verwenden Sie diese OptionUpdatePurchaseOrders, um eine Bestellnummer hinzuzufügen, nachdem Sie ein Produkt abonniert haben. Verwenden Sie das chargeId und chargeRevision aus der Gebühren für die Vereinbarung auflisten Antwort. Sobald eine Bestellung mit einer Gebühr verknüpft wurde, enthält die für diese Gebühr generierte Rechnung die Bestellnummer.

client.update_purchase_orders(
    agreementId='agmt-abc123',
    purchaseOrders=[
        {
            'chargeId': 'charge-xyz',
            'chargeRevision': 1,
            'purchaseOrderReference': 'PO-2024-001'
        }
    ]
)

Stornierungsanfragen auflisten

Verwenden Sie diese ListAgreementCancellationRequests Option, um alle Stornierungsanfragen für Verträge aufzulisten, an denen Sie teilnehmen. Sie können nach Vereinbarung, Status und anderen Kriterien filtern.

response = client.list_agreement_cancellation_requests(
    partyType='Acceptor',
    agreementId='agmt-abc123'
)

for req in response['agreementCancellationRequests']:
    print(f"  {req['agreementCancellationRequestId']}: {req['status']}")

Einzelheiten zur Stornierungsanfrage abrufen

Dient GetAgreementCancellationRequest zum Abrufen detaillierter Informationen zu einer bestimmten Stornierungsanfrage, einschließlich Status, Zeitstempel und Ursachencodes.

response = client.get_agreement_cancellation_request(
    agreementId='agmt-abc123',
    agreementCancellationRequestId='acr-abc123'
)

print(f"Status: {response['status']}")
print(f"Reason: {response['reasonCode']}")

Akzeptieren Sie eine Stornierungsanfrage

Wird verwendetAcceptAgreementCancellationRequest, um eine vom Verkäufer initiierte Stornierungsanfrage zu genehmigen. Nach der Genehmigung wird der Workflow zur Kündigung des Vertrags asynchron ausgeführt. Sie benötigen außerdem eine CancelAgreement Genehmigung, da die Genehmigung der Stornierungsanfrage zur Kündigung der Vereinbarung führt.

client.accept_agreement_cancellation_request(
    agreementId='agmt-abc123',
    agreementCancellationRequestId='acr-abc123'
)

Lehnen Sie eine Stornierungsanfrage ab

Wird verwendetRejectAgreementCancellationRequest, um eine vom Verkäufer initiierte Stornierungsanfrage abzulehnen. Nach der Ablehnung bleibt die Vereinbarung aktiv und der Verkäufer kann bei Bedarf eine neue Stornierungsanfrage stellen.

client.reject_agreement_cancellation_request(
    agreementId='agmt-abc123',
    agreementCancellationRequestId='acr-abc123'
)

Zahlungsanfragen auflisten

Verwenden Sie diese ListAgreementPaymentRequests Option, um alle Zahlungsanfragen für Vereinbarungen aufzulisten, an denen Sie teilnehmen. Sie können nach Vereinbarung, Status und anderen Kriterien filtern.

response = client.list_agreement_payment_requests(
    partyType='Acceptor',
    agreementId='agmt-abc123'
)

for req in response['agreementPaymentRequests']:
    print(f"  {req['agreementPaymentRequestId']}: {req['status']}")

Details zur Zahlungsanfrage abrufen

Dient GetAgreementPaymentRequest zum Abrufen detaillierter Informationen zu einer bestimmten Zahlungsanforderung, einschließlich Status, Zeitstempel und damit verbundener Gebühren.

response = client.get_agreement_payment_request(
    paymentRequestId='apr-abc123',
    agreementId='agmt-abc123'
)

print(f"Status: {response['status']}")
print(f"Amount: ${response['amount']}")

Akzeptieren Sie eine Zahlungsanforderung

Wird verwendetAcceptAgreementPaymentRequest, um eine vom Verkäufer initiierte Zahlungsanforderung für eine aktive Vereinbarung zu genehmigen.

client.accept_agreement_payment_request(
    paymentRequestId='apr-abc123',
    agreementId='agmt-abc123'
)

Lehnen Sie eine Zahlungsanforderung ab

Wird verwendetRejectAgreementPaymentRequest, um eine vom Verkäufer initiierte Zahlungsanforderung abzulehnen. Nach der Ablehnung kann der Verkäufer bei Bedarf eine neue Zahlungsanforderung erstellen.

client.reject_agreement_payment_request(
    paymentRequestId='apr-abc123',
    agreementId='agmt-abc123'
)