OPG.13-开放网关操作API技术实现指南，1.0版

1. 引言

• 背景: GSMA Open Gateway (OGW) 是电信行业统一服务交付和管理的重大举措，旨在通过标准化 API 提升互操作性、简化服务管理并促进创新。
• 目的: 本指南为运营商、服务聚合商和技术合作伙伴提供 TMF Operate API 技术实现指南，支持他们在 OGW 生态系统中作为聚合商/渠道合作伙伴使用运营商的 API 产品。
• 范围: 指南涵盖 API 产品目录检索、API 产品订购和 API 产品使用检索的 Operate API 利用。
• 目标受众: 运营商、渠道合作伙伴和监管机构。

2. 聚合模式

• 模式描述: 在 OGW 聚合模式下，渠道合作伙伴通常按国家进行boarding，并与本地运营商使用 Operate API。
• API 产品: API 产品提供和规范由 TMF936 产品目录 API 定义。
• 订购流程: 聚合商并行向运营商请求 API 产品订购，并通过 TMF931 Onboarding API 在每个运营商上进行客户端应用程序的配置。
• 使用报告: 运营商通过 TMF937 使用 API 向聚合商报告 API 产品使用情况。

3. TMF Operate API 常规实现指南

• 同步与异步操作: TMF API 通常支持同步和异步操作模式，但出于互操作性原因，需要实现同步操作。
• 字符串格式和限制: 大多数字符串属性没有长度限制，但为了互操作性，需要遵循一些指南。
• API 安全: 必须使用 OpenId Connect (OIDC) 扩展 OAuth 2.0 进行 API 身份验证，并使用 client_credentials 授权类型。
• API Web 通知安全: 接收通知的 API 客户端应使用 OAuth 2.0 进行身份验证。
• HTTP X-Correlator Header: 建议添加可选的 x-correlator 头以实现端到端可观察性。
• HTTP 语言选择: API 客户端可以包含 Accept-Language 头，API 将尝试匹配首选语言。

4. TMF931 Onboarding and Ordering API 指南

• 强制操作: 包括应用程序所有者、应用程序和 API 产品订购的创建和更新。
• API 安全: 使用 OIDC 扩展 OAuth 2.0 进行身份验证，并使用 client_credentials 授权类型。
• 渠道合作伙伴 Onboarding 流程: 渠道合作伙伴应能够接收 Onboarding API 通知。
• 审批状态: 应用程序所有者和应用程序的审批状态对 API 产品订购至关重要。
• 税号格式: 根据参与国家和应用程序所有者的国家/地区，遵循不同的税号格式规则。
• ApiProductOrder: 表示添加、修改或删除 API 产品的订单列表。
• 事件订阅: 必须支持 TMF931 Onboarding API 中定义的所有通知事件。
• Monitor: 支持以下 Monitor 状态值：InProgress、InError 和 Completed。
• 完整 Onboarding 和订购流程: 包括应用程序所有者创建、应用程序创建、ApiProductOrder 创建和订单处理。
• PATCH 操作: 可用于修复被拒绝的创建请求或传达数据更新。
• 区域指南: 包括巴西的 CNPJ 税号格式和欧盟的 GDPR 指南和 VAT 税号格式。

5. TMF936 产品目录 API 指南

• 本章节内容待进一步研究。

6. TMF937 产品使用 API 指南

• 本章节内容待进一步研究。

附件

• A. Onboarding API 示例: 包括应用程序所有者、应用程序、ApiProductOrder 和 Hub-事件订阅的示例。
• B. 文档管理: 包括文档历史记录和其他信息。