Apple 商务使用手册

在 Apple 商务中设置 Webhook
具有 API 访问权限的第三方合作伙伴可以使用 Webhook,在不同资源和活动的状态有所变更时收到推送通知。通过 Webhook 接收的消息类型与通过 Notifications API 接收的消息类型保持一致。
【注】在使用 Webhook 之前,你需要拥有 Apple 商务 API 的访问权限,并且每个环境都需要经过 Apple 批准。了解如何请求 API 访问权限。
创建首个 Webhook
在 Apple 商务中,使用具有组织管理员职务的用户账户登录。
如需查看职务和权限,请参阅“职务和权限简介”。
选择“API”。
选择“添加 Webhook”旁边的
,然后输入以下信息:信息
描述
Webhook
可包含字母、数字和符号,但以下各项除外:
;(分号)
’(撇号)
[(左方括号)
](右方括号)
<(小于号)
>(大于号)
团队成员
具备管理员或开发者职务的团队成员,用于在连接失败时联系你的团队
环境
限制:
Webhook 设置完成后,环境无法更改。
一个活动在每个环境中只能使用一次。
负载网址(URL)
需要以 https:// 开头
活动
至少需要选择一项资源或其他活动
【注】添加 Webhook 信息后,系统会向该网址(URL)发送一次 Ping 测试,用于验证连接。
选择“存储”。
选择“拷贝”,将客户端密码拷贝到剪贴板。
给 Webhook 管理员发送客户密钥。
在管理员确认收到客户端密码后,选择“完成”。
编辑 Webhook
在 Apple 商务中,使用具有组织管理员职务的用户账户登录。
如需查看职务和权限,请参阅“职务和权限简介”。
选择“API”。
选择“管理 Webhook”旁边的
,然后从列表中选择一个 Webhook。你可以更改以下内容:
Webhook 的名称
Webhook 的状态
一位团队成员的姓名,用于在连接失败时联系你的团队
负载网址(URL)
如需生成新的客户密钥,你可以选择“创建新客户密钥”,然后选择“创建”。
给 Webhook 管理员发送客户密钥。
在管理员确认收到客户端密码后,选择“完成”。
选择希望收到相关通知的资源和活动。
【注】同一 Webhook 环境中所使用的资源不可供两个及以上 Webhook 同时使用。
选择“存储”。