快速简单对接【短信验证码】接口
很多企事业单位,或者个体开发者,以及学生等都会在日常工作/学习中,要用到短信验证码等服务,需要API接口对接,本文将为大家介绍如何对接短信API接口服务,以及相关的流程,希望对您有所帮助哦。
一、接入流程:
1. 购买接口套餐( 可先用免费试用套餐)
2. 获取接口中需要的参数信息
3. API接口调试对接(可使用postman等调试工具)
4. 正式上线稳定运行
二、准备工作:
1、购买短信接口套餐
点击打开链接(https://market.aliyun.com/products/57126001/cmapi00037415.html),可以获取短信服务免费试用套餐。您也可以无限购买1分钱特惠套餐。
2、获取秘钥信息(AppCode)
在浏览器打开链接:https://market.console.aliyun.com,可在云市场【已购买的服务】获取APPcode信息。
3、获取接口参数
接口中需要用到的参数,可参见商品详情页。其中参数:【smsSignId】和【templateId】,可以在国阳云平台随时自己申请,操作方法可以询问客服人员(VX:gyhz2018)。
PS.您也可以直接通过参数描述里面提供的测试ID,先行对接测试,待自己的申请好后,再替换即可。
4、下载postman调试工具
您可以使用自己熟悉的调试工具,如:postman等,下载地址:https://www.postman.com/downloads
三、接口调试:
在准备就绪后,可以进行接口调试,您可以通过下述2个方法进行接口调试(可任选其一)。
1、使用商品详情页请求示例(Demo)调试接口
1.1 如果是测试效果,您可以直接使用阿里云市场提供的“调试”工具进行测试;
● 浏览器地址打开链接:https://market.console.aliyun.com,在【已购买的服务】中点击“接口”
● 点击去“去调试”,打开调试页面。
● 在调试页面中,输入测试的手机号码,其他参数可以保持默认(如果您已申请好自己的参数,可以替换为自己的),测试结果如下。
1.2 在测试效果后,您可以直接根据商品详情页提供的请求示例Demo进行代码调试;
2、使用postman工具调试接口
2.1 配置秘钥权限:
将AppCode放在Header中。请求Header中添加Authorization字段,配置Authorization字段的值为“APPCODE + 半角空格 +APPCODE值”。
格式如下: Authorization:APPCODE AppCode值
示例如下: Authorization:APPCODE 34534ddjf4448911D39A4jgjkwerwerewejg94
2.2 配置body参数:
请求体格式选择: 'Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8'
body参数设置:参考商品详情页api信息:
2.3 导出接口代码:
接口调通后,选择你所需要的代码类型,整段复制代码使用即可。
四、发布上线
接口调试完成后,将代码合并,发布到生成环境后,观察是否运行正常,无问题后,即完成对接。
五、常见错误
常见错误如下。更多错误可以点击《API网关错误代码表》查看。
错误代码 |
HTTP状态码 |
Message |
描述 |
解决方案 |
A400MA |
400 |
Need authorization, `X-Ca-Key` or `Authorization: APPCODE ...` is required |
需要使用`Key/Secret`签名授权或`AppCode`授权 |
1.请检查APPcode是否正确; 2.APPcode和其值之间需英文空格分开 |
B403MQ |
403 |
Api Market Subscription quota exhausted |
购买的云市场API配额已耗尽 |
购买套餐即可 |
I413RL |
413 |
Request body too Large |
请求包体过长 |
做精简 |
I413UL |
413 |
Request URL too Large |
请求URL过长 |
做缩减 |
1803 |
1803 |
到达业务短信限流 |
触发限流规则:测试签名同一个号码,1分钟1次,1小时5次,24小时10次,不支持大量商用 |
可申请自己的签名,或者更换手机号码测试。 |
1321 |
1321 |
模板参数格式不正确 |
一般是因为验证码的格式不正确。 |
1.若是使用的测试签名,则验证码只能是数字,且长度在10位以内; 2.若是自定义签名,则验证码只能是数字+字母,且长度在10以内; 3.若验证码需要包含其他内容,或者超过10位时,需要联系客服配置 |
1324 |
1324 |
当前模板不可用(可能原因:模板ID错误、审核中、或者审核未通过、已被禁用等! |
可能原因:模板ID错误、审核中、或者审核未通过、已被禁用等! |
检查模板状态是否正常 |
1205 |
1205 |
当前签名不可用(可能原因:签名ID错误、审核中、或者审核未通过、已被禁用等! |
可能原因:签名ID错误、审核中、或者审核未通过、已被禁用等! |
检查签名状态是否正常 |