使用强类型 API 架构简化您的 AWS Marketplace 目录 API (CAPI) 集成

发布于: 2024年7月19日

我们很高兴地宣布推出 GitHub 库，该库将托管目录 API (CAPI) 中的 StartChangeSet、DescribeChangeSet 和 DescribeEntity API 中使用的 DetailsDocument 的架构。这项新功能旨在简化使用目录 API 的开发人员的集成流程。

如今，作为卖家/合作伙伴组织的开发人员，在与目录 API 集成以进行诸如增加定价维度之类的操作时，需要手动构建 API 请求结构。这包括查看 API 文档并尝试理解请求的“DetailsDocument”的架构。使用新的架构库，您可以直接导入 Java 和 Python 库来创建强类型响应，而无需参考文档或尝试 JSON 结构。这将节省时间并降低集成测试和实施期间出错的风险。此外，如果对 DetailsDocument 架构进行了更改，您只需下载该库的新版本，查看更改并对代码进行必要的更新即可。这项新功能将与发送和接收字符串对象一起存在于 StartChangeSet、DescribeChangeSet 和 DescribeEntity API 的“Details”属性中。如果您已经集成了这些 API，则可以继续使用“Details”属性。但是，建议新加入的卖家和加入新 API 操作的卖家使用架构库来加快与目录 API 的集成。

有关如何下载和使用形状库的信息，请参阅 StartChangeSet API、DescribeChangeSet API 和 DescribeEntity API。