Day 10 - API 文件导览总结 - 重点整理

在 Day 9 我们使用 Order API 建立了一笔测试订单。

在送出请求的 JSON 字串是这样的。

图 10-1: JSON 字串排版

当时我们建立订单时的 APIService 栏位是 OrderCreate，这个栏位决定了要请 Order API 做什麽事情，而 Message 栏位则是加密过後的讯息 JSON 字串。

Order API 其它服务

除了建立订单以外，Order API 还有其它两个查询订单的功能，如下:

批次订单查询

• APIService: OrderQuery

图 10-2: 文件第 38 页 7.2. 订单交易查询

需求栏位范例:

*图 10-3: OrderQuery 需求栏位

ShopNo 栏位是必填栏位，其余栏位选填。最大查询笔数 300 笔。

单笔订单查询

• APIService: OrderPayQuery

图 10-4: 文件第 44 页 7.3. 讯息查询服务

需求栏位范例:

*图 10-5: OrderPayQuery 需求栏位

ShopNo 及 PayToken 栏位皆必填。此功能透过交易完成时跳转回商店网站的 ReturnURL 参数提供 PayToken 值。或 API 平台透过建立订单时的 BackendURL 栏位主动传值通知。

讯息通知

*图 10-6: 文件第 47 页 7.4. 即时讯息通知

这边的作法是商店网站必须建立一个专门收此讯息通知的网址，然後把该网址当作建立订单时的 BackendURL 栏位。当完成请款後，永丰金收款平台会主动通知，传送 Pay Token。商店网站再使用该 Pay Token 查询订单状态。

收款平台 POST 到商店网站的资料范例，同图 10-5。

总结

这 10 天的文章大家导览了这份 API 文章，也说明了各项计算所需杂凑值以及加、解密的过程，一直到建立了测试订单，重点整理如下表格：

希望对大家有帮助！如有问题也欢迎提问。明天即将发布 PHP SDK 及使用范例，让使用 PHP 的开发人员能写几行程序码就能完成这 10 天的所有内容喔！大幅减低串接的门槛，欢迎有兴趣的朋友准时收看。

另外 API 文件有错误的地方，如下图：

*图 10-7: 文件第 32 页

ExpBillingDays 的可设定范围 1-21，但实际上只能给 1-7，超过就会回错：

E1001 – 自动请款天数设定范围错误,最小值为:1,最大值为:7

请大家多留意一下。

本文更新於笔者的 TerryL 部落格，Day 10 - API 文件导览总结 - 重点整理，有兴趣可前往阅读及讨论。