AWS Marketplace API 참조가 재구성되었습니다. 지원되는 API 작업에 대한 자세한 내용은 AWS Marketplace API 참조를 참조하세요.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

구매자로서 계약 API 작업

계약은 제안자와 수락자(일반적으로 구매자)를 포함하여 두 당사자를 구속하고 이들 간에 적용되는 이용 약관을 정의하는 문서입니다.

구매자는 견적을 생성하는 AgreementRequest를 생성합니다. 이 견적에는 구매자의 구매 결정에 중요한 계약 기간 동안 발생할 예상 요금과 같은 모든 관련 정보가 포함되어 있습니다. 구매자가 견적에 만족하면 만료되기 전에 AgreementRequest를 수락할 수 있습니다. 계약은 AgreementRequest를 수락하면 생성됩니다. 이 프로세스 중에 구매자 관리자 또는 구매자 페르소나는 구매 주문을 요금에 연결할 수 있습니다. 마지막으로 유효한 계약의 이용 약관에 따라 구매자에게 인보이스가 발행되고 제품을 사용할 수 있는 라이선스가 부여됩니다.

사전 조건: 제품 및 제안 검색

계약을 생성하기 전에 AWS Marketplace Discovery API를 사용하여 제품을 검색하고 agreementProposalId를 구성하는 데 필요한 pricingModel, 및 기간 세부 정보를 가져옵니다CreateAgreementRequest.

제품 및 요금 검색에 대한 자세한 내용은 섹션을 참조하세요제품 및 요금 알아보기.

수락자는이 API를 사용하여 다음 작업을 수행할 수 있습니다.

따옴표 생성

를 사용하여 따옴표를 CreateAgreementRequest 생성합니다. 다음을 제공해야 합니다.

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 구성

를 구성하려면 다음 두 가지 사항을 결정requestedTerms해야 합니다.

요금 모델별 필수 조건

GetOffer 응답의 pricingModel.PricingModel 필드에 따라에 포함해야 하는 용어가 결정됩니다CreateAgreementRequest.

제안에 있는 경우 모든 계약에 LegalTerm, SupportTerm, 및 조건을 포함해야 합니다ValidityTermRenewalTerm.

계약

GetOfferTerms에서 반환하는 모든 용어는 단일에서 필요합니다CreateAgreementRequest.

사용량

계약 생성은 제안에 있는 조건에 따라 달라집니다.

BYOL

필수 조건과 ByolPricingTerm 함께 수락합니다.

용어 구성

대부분의 용어에는 GetOfferTermsid의 만 필요합니다. 다음 용어 유형은 configuration 외에도 구매자가 제공해야 합니다. id

ConfigurableUpfrontPricingTermConfiguration

아래 예제를 사용하여에 필요한 값을 찾습니다ConfigurableUpfrontPricingTermConfiguration.

GetOfferTerms 응답 예:

{
  "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"
      }
    }
  ]
}

에 대한 RequestedTerm페이로드 예제ConfigurableUpfrontPricingTerm:

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

RenewalTermConfiguration

에 대한 RequestedTerm페이로드 예제RenewalTerm:

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

VariablePaymentTermConfiguration

에 대한 RequestedTerm페이로드 예제VariablePaymentTerm:

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

제안 수락

먼저에 설명된 대로 따옴표를 생성합니다따옴표 생성. 그런 다음 AcceptAgreementRequest를 사용하여 견적을 수락하고 계약을 생성합니다. 계약 요청이 만료AcceptAgreementRequest되기 전에를 호출해야 합니다. 수락 중에 구매 주문 번호를 선택적으로 연결할 수 있습니다.

# 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']}")

기존 계약 교체

에 설명된 CreateAgreementRequest 대로를 구성하되 따옴표 생성intent를 로 설정하고 대체할 계약을 REPLACE sourceAgreementIdentifier 제공합니다. 그런 다음를 호출AcceptAgreementRequest하여 교체를 완료합니다.

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

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

기존 계약 수정

기존 계약의 기간 구성을 수정하려면를 intent 로 설정하고를 AMEND 제공합니다sourceAgreementIdentifier. 새 계약과 달리 agreementProposalIdentifier는 필요하지 않습니다. 구성을 변경하려는 용어만 포함합니다. 그런 다음를 호출AcceptAgreementRequest하여 수정 사항을 적용합니다.

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']}")

자동 갱신 활성화 또는 비활성화

AMEND 의도와 CreateAgreementRequest 함께를 사용하여 자동 갱신을 전환합니다.

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']}")

계약 취소

CancelAgreement를 사용하여 사용 계약을 취소합니다. 다른 계약 유형의 경우 구매자는 판매자에게 연락하여 취소를 시작해야 합니다.

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

계약 검색

SearchAgreements를 사용하여 수락자로 참여하는 모든 계약을 검색합니다. 검색은 기본 계약 정보가 포함된 계약 목록을 반환합니다.

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']}")

계약 설명

제안자, 수락자, 시작 날짜 및 종료 날짜와 같은 계약에 대한 세부 정보를 보는 DescribeAgreement 데 사용합니다.

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

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

계약 조건 가져오기

GetAgreementTerms를 사용하여 수락자로 참여하는 계약의 조건에 대한 세부 정보를 얻습니다.

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

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

계약 권한 가져오기

GetAgreementEntitlements를 사용하여 계약과 연결된 권한의 상태 및 세부 정보를 계약 수준에서 확인할 수 있습니다.

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

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

등록 토큰 가져오기

GetAgreementEntitlements를 사용하여 등록 토큰을 가져옵니다. 이 수명이 짧은 토큰(30분 동안 유효)은 수락자가 제안자가 있는 계정을 설정하는 데 필요합니다. 현재 SaaS 구매 계약에만 적용됩니다.

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

계약 요금 나열

ListAgreementCharges를 사용하여 계약과 관련된 요금 및 구매 주문 세부 정보를 봅니다.

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')}")

구매 주문 업데이트

제품을 구독한 후 구매 주문 번호를 추가하는 UpdatePurchaseOrders 데 사용합니다. 계약 요금 나열 응답에서 chargeId 및 chargeRevision를 사용합니다. 구매 주문이 요금과 연결되면 해당 요금에 대해 생성된 인보이스에 구매 주문 번호가 포함됩니다.

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

취소 요청 나열

ListAgreementCancellationRequests를 사용하여 참여하는 계약에 대한 모든 취소 요청을 나열합니다. 계약, 상태 및 기타 기준을 기준으로 필터링할 수 있습니다.

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

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

취소 요청 세부 정보 가져오기

GetAgreementCancellationRequest를 사용하여 상태, 타임스탬프 및 사유 코드를 포함하여 특정 취소 요청에 대한 세부 정보를 검색합니다.

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

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

취소 요청 수락

판매자가 시작한 취소 요청을 승인AcceptAgreementCancellationRequest하는 데 사용합니다. 승인 후 계약 취소 워크플로는 비동기적으로 실행됩니다. 취소 요청을 승인하면 계약이 취소되므로 CancelAgreement 권한도 필요합니다.

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

취소 요청 거부

판매자가 시작한 취소 요청을 거부RejectAgreementCancellationRequest하는 데 사용합니다. 거부 후에도 계약은 활성 상태로 유지되며 판매자는 필요한 경우 새 취소 요청을 생성할 수 있습니다.

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

결제 요청 나열

ListAgreementPaymentRequests를 사용하여 참여하는 계약에 대한 모든 결제 요청을 나열합니다. 계약, 상태 및 기타 기준을 기준으로 필터링할 수 있습니다.

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

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

결제 요청 세부 정보 가져오기

상태, 타임스탬프 및 관련 요금을 포함하여 특정 결제 요청에 대한 세부 정보를 검색하는 GetAgreementPaymentRequest 데 사용합니다.

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

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

결제 요청 수락

활성 계약에 대해 판매자가 시작한 결제 요청을 승인AcceptAgreementPaymentRequest하는 데 사용합니다.

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

결제 요청 거부

판매자가 시작한 결제 요청을 거부RejectAgreementPaymentRequest하는 데 사용합니다. 거부 후 판매자는 필요한 경우 새 결제 요청을 생성할 수 있습니다.

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