推送通知 API 设置
概述
我们提供多个推送 API,允许用户接收可用的详细信息,例如库存情况、发货和财务信息。这些 API 可用于客户自动化流程。要设置推送通知,请执行以下操作:
- 登录 TI.com 后,点击用户名称旁边的下拉菜单并选择“myTI 帐户”。
- 在 myTI 帐户的左侧导航菜单中,点击“公司帐户”下的“API 密钥和访问权限”。
- 展开“TI store API 套件”部分。
- 点击您需要设置的推送 API 旁边的齿轮图标。
如何完成此表单
API URL:您的 API URL,该 URL 将接受来自 TI 的 POST 请求。TI API 推送通知将在此处发送(在创建出货前通知文档时的特定屏幕截图中)。
数据格式:在 TI API 发送的 POST 请求中接收的数据格式(JSON 或 XML,如果支持)。默认为 JSON。
身份验证类型:当调用您的 API 时,我们支持 2 种身份验证类型:
- 基本身份验证(您需要指定用户名称和密码,如下所示)识别特定的用户。
- 令牌(您为我们提供一个密钥,TI API 将在特定的标头中发送该密钥)识别特定的应用程序。
API 请求参数:这是一个可选字段,您可以在其中定义 TI API 在调用您的 API 时将包含的参数。您可以指定“将日期偏移五天”或“将结果限制为前五个结果”之类的内容。
TI 致力于保护您的系统和 TI 免受安全威胁,要求客户终点满足启用 API 回调功能的特定指导原则。您在 myTI 帐户中的推送 API 设置以及从 TI 到您指定终点的单独 API 调用将受到审核,如果未遵循下述优秀实践,则可能会撤销对推送 API 的访问权限。
- 使用具有 SSL 加密和有效证书的 HTTPS webhook URL。
- API 应实施安全方案以限制访问。优先使用令牌身份验证方法,但如果需要,也支持基本身份验证。
- 请勿使用动态 DNS、重定向程序、匿名程序或 tor2web 服务。
- 请勿使用攻击性、滥用性、欺诈性或被禁止的顶级域名。
- 如果可能,您的 API URL 的域应与您的 myTI 客户域相匹配。
- 请勿使用 IP 地址。
- 请勿使用重定向或中继 URL 参数。
- 确保您保存在 myTI API 设置中的终点 URL 允许外部请求。
- 确保您的防火墙允许外部请求。
- 终点应采用 JSON 数据格式。
- “API 请求参数”是可选的,如果您想在对 TI 进行 API 调用时建立其他设置,则可以使用这些参数。
审核和批准 API 端点以及保护 API 回调功能的流程将持续发展和改进,我们感谢您的合作。