本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# SaaS 产品集成的代码示例
您可以使用以下代码示例将您的软件 AWS Marketplace APIs 即服务 (SaaS) 产品与发布和维护产品所需的产品集成。有关更多信息，请参阅以下部分。
**Topics**
+ [`ResolveCustomer` 代码示例](#saas-resolvecustomer-example)
+ [`GetEntitlement` 代码示例](#saas-getentitlement-example)
+ [`BatchMeterUsage` 代码示例](#saas-batchmeterusage-example)
+ [`BatchMeterUsage`代码示例：使用许可证 ARN](#saas-batchmeterusage-licensearn-example)
+ [带有用量分配标签的 `BatchMeterUsage` 代码示例（可选）](#saas-batchmeterusage-tagging)
## `ResolveCustomer` 代码示例
以下代码示例与所有定价模式相关。Python 示例使用`x-amzn-marketplace-token`令牌兑换`CustomerIdentifier``ProductCode`、`LicenseArn`、和`CustomerAWSAccountId`。`CustomerAWSAccountId`是与订阅关联的 AWS 账户 ID，`LicenseArn`也是特定已授予许可证的唯一标识符。这些用于通过购买的软件 AWS Marketplace。此代码在注册网站上的应用程序中运行（当您从 AWS Marketplace 管理门户重定向到该位置时）。重定向是一个包含令牌的 POST 请求。
有关更多信息`ResolveCustomer`，请参阅《*AWS Marketplace 计量服务 API 参考*》[ResolveCustomer](https://docs.aws.amazon.com/marketplacemetering/latest/APIReference/API_ResolveCustomer.html)中的。
**注意**
要进行新的实施或更新集成时，请使用客户 AWSAccount ID 代替 CustomerIdentifier。
```
# Import AWS Python SDK and urllib.parse
import boto3
import urllib.parse as urlparse
# Resolving Customer Registration Token
formFields = urlparse.parse_qs(postBody)
regToken = formFields['x-amzn-marketplace-token'][0]
# If regToken present in POST request, exchange for customerID
if (regToken):
marketplaceClient = boto3.client('meteringmarketplace')
customerData = marketplaceClient.resolve_customer(RegistrationToken=regToken)
productCode = customerData['ProductCode']
customerID = customerData['CustomerIdentifier']
customerAWSAccountId = customerData['CustomerAWSAccountId']
licenseARN = customerData['LicenseArn']
# TODO: Store customer information
# TODO: Validate no other accounts share the same customerID
```
### 响应示例
```
{
'CustomerIdentifier': 'string',
'CustomerAWSAccountId':'string',
'ProductCode': 'string',
'LicenseArn' : 'string'
}
```
## `GetEntitlement` 代码示例
以下代码示例与具有合同的 SaaS 产品和具有消费定价模式的 SaaS 合同相关。Python 示例将验证客户是否具有有效权限。
有关更多信息`GetEntitlement`，请参阅《*AWS Marketplace 授权服务 API 参考*》[GetEntitlement](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html)中的。
```
# Import AWS Python SDK
import boto3
marketplaceClient = boto3.client('marketplace-entitlement', region_name='us-east-1')
# Filter entitlements for a specific customerID
#
# productCode is supplied after the AWS Marketplace Ops team has published
# the product to limited
#
# customerID is obtained from the ResolveCustomer response
entitlement = marketplaceClient.get_entitlements({
'ProductCode': 'productCode',
'Filter' : {
# Option 1: Using CustomerIdentifier (for new or updated integrations, use the customer AWS account ID)
'CUSTOMER_IDENTIFIER': [
'customerID',
]
# Option 2: Using CustomerAWSAccountId (preferred)
# 'CUSTOMER_AWS_ACCOUNT_ID': [
# 'awsAccountId',
# ]
# Option 3: Using LICENSE_ARN (to get entitlements for the license)
# 'LICENSE_ARN': [
# 'licenseARN',
# ]
},
'NextToken' : 'string',
'MaxResults': 123
})
# TODO: Verify the dimension a customer is subscribed to and the quantity,
# if applicable
```
### 响应示例
返回的值与您在 AWS Marketplace 管理门户中创建产品时所创建的维度对应。
```
{
"Entitlements": [
{
"CustomerIdentifier": "string",
"CustomerAWSAccountId": "string",
"Dimension": "string",
"ExpirationDate": number,
"ProductCode": "string",
"LicenseArn": "string",
"Value": {
"BooleanValue": boolean,
"DoubleValue": number,
"IntegerValue": number,
"StringValue": "string"
}
}
],
"NextToken": "string"
}
```
## `BatchMeterUsage` 代码示例
以下代码示例与具有消费定价模式的 SaaS 订阅和合同相关，但不适用于不带消费的 SaaS 合同产品。Python 示例向发送了一份计量记录 AWS Marketplace ，向您的客户收取 pay-as-you-go费用。
```
# NOTE: Your application will need to aggregate usage for the
# customer for the hour and set the quantity as seen below.
# AWS Marketplace can only accept records for up to an hour in the past.
#
# productCode is supplied after the AWS Marketplace Ops team has
# published the product to limited
#
# You can use either:
# - customerID from the ResolveCustomer response
# - AWS account ID of the buyer
# Import AWS Python SDK
import boto3
from datetime import datetime
# Option 1: Using CustomerIdentifier (for new or updated integrations, use the customer AWS account ID)
usageRecord = [
{
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'customerID',
'Dimension': 'string',
'Quantity': 123
}
]
# Option 2: Using CustomerAWSAccountId (preferred)
# usageRecord = [
# {
# 'Timestamp': datetime(2015, 1, 1),
# 'CustomerAWSAccountId': 'awsAccountId',
# 'Dimension': 'string',
# 'Quantity': 123
# }
# ]
marketplaceClient = boto3.client('meteringmarketplace')
response = marketplaceClient.batch_meter_usage(
UsageRecords=usageRecord,
ProductCode='productCode'
)
```
有关更多信息`BatchMeterUsage`，请参阅《*AWS Marketplace 计量服务 API 参考*》[BatchMeterUsage](https://docs.aws.amazon.com/marketplacemetering/latest/APIReference/API_BatchMeterUsage.html)中的。
### 响应示例
```
{
'Results': [
{
'UsageRecord': {
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'string',
'CustomerAWSAccountId': 'string',
'Dimension': 'string',
'Quantity': 123
},
'MeteringRecordId': 'string',
'Status': 'Success' | 'CustomerNotSubscribed' | 'DuplicateRecord'
},
],
'UnprocessedRecords': [
{
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'string',
'CustomerAWSAccountId': 'string',
'Dimension': 'string',
'Quantity': 123
}
]
}
```
## `BatchMeterUsage`代码示例：使用许可证 ARN
以下代码示例与支持并发协议的 SaaS 产品相关。当买家注册您的商品时，`ResolveCustomer`API 会返回`LicenseArn`和`CustomerAWSAccountId`。
```
# NOTE: Your application will need to aggregate usage for the
# customer for the hour and set the quantity as seen below.
# AWS Marketplace can only accept records for up to an hour in the past.
#
# LicenseArn and CustomerAWSAccountId are returned by the ResolveCustomer
# API when a buyer registers to your product
# Import AWS Python SDK
import boto3
from datetime import datetime
usageRecord = [{
'LicenseArn' : 'licenseArn',
'Timestamp': datetime(2015, 1, 1),
'CustomerAWSAccountId': 'awsAccountId',
'Dimension': 'string',
'Quantity': 123
}]
marketplaceClient = boto3.client('meteringmarketplace')
response = marketplaceClient.batch_meter_usage(
UsageRecords = usageRecord
)
```
### 响应示例
```
{
'Results': [
{
'UsageRecord': {
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'string',
'CustomerAWSAccountId': 'string',
'Dimension': 'string',
'Quantity': 123,
'LicenseArn': 'string'
},
'MeteringRecordId': 'string',
'Status': 'Success' | 'CustomerNotSubscribed' | 'DuplicateRecord'
},
],
'UnprocessedRecords': [
{
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'string',
'CustomerAWSAccountId': 'string',
'Dimension': 'string',
'Quantity': 123,
'LicenseArn': 'string'
}
]
}
```
## 带有用量分配标签的 `BatchMeterUsage` 代码示例（可选）
以下代码示例适用于采用用量定价模式的 SaaS 订阅和合同，但不适用于未采用用量定价模式的 SaaS 合同产品。Python 示例将带有相应使用量分配标签的计量记录发送给您的客户 AWS Marketplace ，以向您的客户收取 pay-as-you-go费用。
```
# NOTE: Your application will need to aggregate usage for the
# customer for the hour and set the quantity as seen below.
# AWS Marketplace can only accept records for up to an hour in the past.
#
# productCode is supplied after the AWS Marketplace Ops team has
# published the product to limited
#
# You can use either:
# - customerID from the ResolveCustomer response
# - AWS account ID of the buyer
# Import AWS Python SDK
import boto3
import time
# Option 1: Using CustomerIdentifier (for new or updated integrations, use the customer AWS account ID)
usageRecords = [
{
"Timestamp": int(time.time()),
"CustomerIdentifier": "customerID",
"Dimension": "Dimension1",
"Quantity": 3,
"UsageAllocations": [
{
"AllocatedUsageQuantity": 2,
"Tags": [
{ "Key": "BusinessUnit", "Value": "IT" },
{ "Key": "AccountId", "Value": "*********" },
]
},
{
"AllocatedUsageQuantity": 1,
"Tags": [
{ "Key": "BusinessUnit", "Value": "Finance" },
{ "Key": "AccountId", "Value": "*********" },
]
},
]
}
]
# Option 2: Using CustomerAWSAccountId (preferred)
# usageRecords = [
# {
# "Timestamp": int(time.time()),
# "CustomerAWSAccountId": "awsAccountId",
# "Dimension": "Dimension1",
# "Quantity": 3,
# "UsageAllocations": [
# {
# "AllocatedUsageQuantity": 2,
# "Tags": [
# { "Key": "BusinessUnit", "Value": "IT" },
# { "Key": "AccountId", "Value": "*********" },
# ]
# },
# {
# "AllocatedUsageQuantity": 1,
# "Tags": [
# { "Key": "BusinessUnit", "Value": "Finance" },
# { "Key": "AccountId", "Value": "*********" },
# ]
# },
# ]
# }
# ]
marketplaceClient = boto3.client('meteringmarketplace')
response = marketplaceClient.batch_meter_usage(
UsageRecords=usageRecords,
ProductCode="testProduct"
)
```
有关的更多信息`BatchMeterUsage`，请参阅 *AWS Marketplace Metering Service API 参考[BatchMeterUsage](https://docs.aws.amazon.com/marketplacemetering/latest/APIReference/API_BatchMeterUsage.html)*中的。
### 响应示例
```
{
"Results": [
{
"Timestamp": "1634691015",
"CustomerIdentifier": "customerId",
"CustomerAWSAccountId": "awsAccountId",
"Dimension": "Dimension1",
"Quantity": 3,
"UsageAllocations": [
{
"AllocatedUsageQuantity": 2,
"Tags": [
{ "Key": "BusinessUnit", "Value": "IT" },
{ "Key": "AccountId", "Value": "*********" }
]
},
{
"AllocatedUsageQuantity": 1,
"Tags": [
{ "Key": "BusinessUnit", "Value": "Finance" },
{ "Key": "AccountId", "Value": "*********" }
]
}
],
"MeteringRecordId": "8fjef98ejf",
"Status": "Success"
}
],
"UnprocessedRecords": [
{
"Timestamp": "1634691015",
"CustomerIdentifier": "customerId",
"CustomerAWSAccountId": "awsAccountId",
"Dimension": "Dimension1",
"Quantity": 3,
"UsageAllocations": []
}
]
}
```