关于电商API接口测试规范总结|以1688平台接口为例

1688平台接口API接口测试规范总结

目录

    1、参数校验

1688.custom

公共参数

请求地址:申请1688官方API接口

名称类型必须描述
keyString调用key(必须以GET方式拼接在URL中)
secretString调用密钥
api_nameStringAPI接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等]
cacheString[yes,no]默认yes,将调用缓存的数据,速度比较快
result_typeString[json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读
langString[cn,en,ru]翻译语言,默认cn简体中文
versionStringAPI版本

请求参数

请求参数:api=

参数说明:其它参数:参考1688开放平台接口文档,与1688的参数一致 https://open.1688.com/api/apidocdetail.htm

名称类型必须描述
apiString1688开放平台的接口名(如:com.alibaba.trade/alibaba.trade.createCrossOrder(跨境订单创建 ))
sessionString授权换取的session_id
[其他参数]String其它参数:参考1688开放平台接口文档,与1688的参数一致
https://open.1688.com/api/apidocdetail.htm

响应参数

Version: Date:

名称类型必须示例值描述

response

Mix0[]响应内容,不同的接口返回内容不一样,具体参考 https://open.1688.com/api/apidocdetail.htm

    2、返回值校验

    3、命名规范

    4、业务判断

    5、安全校验

1、参数校验

1、正常场景

(1)功能按照接口规范要求实现

(2)返回状态码200

2、异常场景

(1)参数为空

直接为空

null

[]

{}

(2)参数错误

(3)无操作权限

(4)特定的业务逻辑报错,涉及敏感的报错不应该有明确的原因,例如登录失败就不能报成密码错误或手机号码错误

(5)单位标准,时间,服务端使用时间戳还是直接日期类型,在接口定义里前后端要一致

(6)重复传参,字段唯一性校验,发送两次请求,接口需要做重复判断处理

3、必填参数

(1)接口文档要求必填的字段

(2)必填参数传参

传参类型和内容都正确

传参类型错误,参数类型非法,例:int传string

必填参数数值范围错误,数值越界

必填参数为空格,前面,中间,尾部

(3)必填参数不传,必填参数全部为空,必填参数部分为空

(4)必填参数组合,有些参数需要配合一起使用时需组合测试

4、非必填参数

(1)接口文档规范要求非必传的参数

(2)正向,所有参数均传正确

(3)逆向

某个参数为空,需要做判空处理

非必填参数少传一个,接收方需要处理

5、升级接口

(1)什么情况下需要升级接口

客户端不支持的接口

业务上有较大变更,和老业务有冲突

(2)升级接口影响

对新版本APP有影响,老版本没有影响

新接口和老接口调用同一个底层,底层有修改,老版本正常回归

6、更新接口字段

(1)新版本和老版本可以共用一个接口,只需要新增字段

(2)更新字段影响

新增字段需要对老版本做兼容处理

新增字段必填,需要做版本控制

新增字段不必填,老版本要兼容

2、返回值校验

1、返回数据是否必要

2、返回数据数量需要限制

案例:

电商下单接口测试环境返回2000多张优惠券

推荐服务挂掉,电商h5页面接口返回全部商品

3、契约验证

如上

3、命名规范

接口、字段命名的含义准确且拼写无误

4、业务判断

1、约束条件

(1)数值限制,例如:规定达到什么数值才能被使用,未达到不可以使用

(2)状态限制,例如:删除状态的数据不可被其他业务关联

(3)关系限制,例如:例如联网锁需要先创建房东,房源才能关联锁

(4)权限限制

防越权

数据权限,没有对应权限的不应返回响应的数据

2、操作对象,例如:非自己创建的数据,不能修改

3、时序分析,例如:要先做完A操作才能进行B操作,即前置条件需要有,下个接口才能进行

5、安全校验

1、防遍历校验

2、防越权校验

3、安全校验,xss、sql注入

4、隐私信息,入参、反参、日志

5、数据加密,入参、下行加密

6、频次限制

7、内容安全

  • 25
    点赞
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Legal Disclaimer........................................................................................................................................................... I Preface ......................................................................................................................................................................... II Table of Contents ........................................................................................................................................................ III 1. Introduction ......................................................................................................................................................... 6 1.1. Glossary.................................................................................................................................................... 6 2. Revision History .................................................................................................................................................... 7 3. Scenario Overview ............................................................................................................................................... 8 3.1. Account Management.............................................................................................................................. 8 3.1.1. Account Status ............................................................................................................................. 8 3.1.2. Account Actions ........................................................................................................................... 8 3.1.2.1. 3.1.2.2. 3.1.2.3. 3.1.2.4. Activate ............................................................................................................................ 9 Enable, Suspend, Disable, Delete..................................................................................... 9 Set/Get Hosting Status................................................................................................... 10 SSO ................................................................................................................................. 12 3.2. Credit Limit............................................................................................................................................. 13 3.3. Billing Statement .................................................................................................................................... 13 3.4. Ticket System (Draft) .............................................................................................................................. 13 3.5. Event Notification................................................................................................................................... 15 3.6. Pricing Info and Realtime Enquiry (Draft) .............................................................................................. 15 3.7. Admin Management (Beta).................................................................................................................... 15 4. API Overview ...................................................................................................................................................... 16 4.1. Account Management............................................................................................................................ 17 4.2. Credit Limit............................................................................................................................................. 17 4.3. Billing Statement .................................................................................................................................... 17 4.4. Ticket System (Draft) .............................................................................................................................. 17 4.5. Event Notification................................................................................................................................... 18 4.6. Pricing Info (Draft) .................................................................................................................................. 18 4.7. Admin Management .............................................................................................................................. 18 4.8. Data Type ............................................................................................................................................... 18 4.9. Error Info ................................................................................................................................................ 18 5. API Call Methods ................................................................................................................................................ 19 5.1. 5.2. 5.3. Request Structure .................................................................................................................................. 20 5.1.1. Service Address .......................................................................................................................... 20 5.1.2. Communication Protocol ........................................................................................................... 20 5.1.3. Request Methods ....................................................................................................................... 20 5.1.4. Request Parameters ................................................................................................................... 20 5.1.5. Character Encoding .................................................................................................................... 20 Public Parameters .................................................................................................................................. 20 5.2.1. Public Request Parameters ........................................................................................................ 20 5.2.2. Public Return Parameters .......................................................................................................... 21 Returned Results .................................................................................................................................... 21 5.3.1. Successful Results ...................................................................................................................... 22 Version:1.3.0 III Alibaba Cloud Partners API Documentation/Table of Contents 5.3.2. Error Results............................................................................................................................... 22 5.4. Signature Mechanism ............................................................................................................................ 23 6. API References.................................................................................................................................................... 25 6.1. 6.2. 6.3. 6.4. 6.5. 6.6. 6.7. 6.8. Account Management............................................................................................................................ 25 6.1.1. CreateAccount............................................................................................................................ 25 6.1.2. GetAccountInfo .......................................................................................................................... 25 6.1.3. QueryAccounts........................................................................................................................... 25 6.1.4. SetAccountStatus ....................................................................................................................... 26 6.1.5. CreateSsoLoginUrl ...................................................................................................................... 26 6.1.6. SetHostingStatus ........................................................................................................................ 26 6.1.7. GetHostingStatus ....................................................................................................................... 27 Credit Limit............................................................................................................................................. 27 6.2.1. InitializeCreditLimit .................................................................................................................... 27 6.2.2. GetCreditLimitInfo ..................................................................................................................... 28 6.2.3. SetCreditLimit ............................................................................................................................ 28 6.2.4. SetWarningThreshold ................................................................................................................ 28 6.2.5. ClearCreditBalance..................................................................................................................... 29 Billing Statement .................................................................................................................................... 29 6.3.1. QueryResellerDailySubscription................................................................................................. 29 6.3.2. QueryResellerDaliyPAYG............................................................................................................. 30 6.3.3. QueryEndUserDailySubscription ................................................................................................ 30 6.3.4. QueryEndUserDailyPAYG............................................................................................................ 31 6.3.5. QueryResellerMonthSummary .................................................................................................. 31 6.3.6. QueryEndUserMonthSummary ................................................................................................. 32 Ticket System (Draft) .............................................................................................................................. 32 6.4.1. CreateTicket ............................................................................................................................... 32 6.4.2. QueryTickets .............................................................................................................................. 33 6.4.3. CreateTicketReply ...................................................................................................................... 34 6.4.4. GetTicketReplies......................................................................................................................... 34 6.4.5. QueryTicketProducts.................................................................................................................. 34 6.4.6. QueryProductFAQs..................................................................................................................... 35 6.4.7. GetAttachmentTempUrl............................................................................................................. 35 Event Notification................................................................................................................................... 35 Pricing Info (Draft).................................................................................................................................. 35 6.6.1. GetRegions ................................................................................................................................. 35 6.6.2. GetProducts ............................................................................................................................... 36 6.6.3. GetComponents ......................................................................................................................... 36 6.6.4. GetPrice...................................................................................................................................... 36 6.6.5. EnquiryRealtimePrice................................................................................................................. 36 Admin Management .............................................................................................................................. 38 6.7.1. CreateAdminAccount ................................................................................................................. 38 6.7.2. GetAdminAccountInfo ............................................................................................................... 38 6.7.3. QueryAdminAccounts ................................................................................................................ 39 6.7.4. SetAdminAccountStatus ............................................................................................................ 39 Data Type ............................................................................................................................................... 39 6.8.1. JsonArrayString<T> .................................................................................................................... 39 Version:1.3.0 IV Alibaba Cloud Partners API Documentation/Table of Contents 6.9. 6.8.2. DateType .................................................................................................................................... 39 6.8.3. AccountType............................................................................................................................... 39 6.8.4. AkType........................................................................................................................................ 40 6.8.5. TicketType .................................................................................................................................. 40 6.8.6. TicketStatusType ........................................................................................................................ 40 6.8.7. TicketReplyType ......................................................................................................................... 40 6.8.8. TicketProductType...................................................................................................................... 40 6.8.9. TicketProductFaqType ................................................................................................................ 41 6.8.10. AdminType ............................................................................................................................... 41 6.8.11. RellserDailySubscriptionType................................................................................................... 41 6.8.12. RellserDailyPAYGType............................................................................................................... 42 6.8.13. EndUserDailySubscriptionType ................................................................................................ 42 6.8.14. EndUserDailyPAYGType ............................................................................................................ 43 6.8.15. ResellerMonthSummaryType .................................................................................................. 43 6.8.16. ResellerMonthPordSummaryType ........................................................................................... 43 6.8.17. EndUserMonthSummaryType.................................................................................................. 44 Error Info ................................................................................................................................................ 44 6.9.1. Common Error Codes................................................................................................................. 44 6.9.2. Http Status Codes....................................................................................................................... 44 7. References.......................................................................................................................................................... 44

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值