快速入门
小智 IoT 接口是面向有一定技术开发能力的企业或者个人用户而单独研发的短信通道通讯协议。
本接口采用了通用的 HTTP 形式,支持 GET 或者 POST 方式接入,
可以支持各种操作系统和开发语言,为您提供了 ASP, ASP.net, Java, PHP, C# 等语言的例子代码,
在您注册了平台账号后获得开发者标识即可通过简单的调试后,
把接口嵌入到您自己的系统中,快速拥有无线应用,完善您的企业服务!
文档说明
本文阅读对象:接入小智 IoT 涉及的技术架构师,研发工程师,测试工程师,系统运维工程师。
准备工作
接入前请在“开发者设置”中设置“开发者状态”为“启用”,并获取“开发者标识”和“开发者密钥”。为保证信息安全,建议定期更换,切勿将开发者信息告知他人。
调用流程
根据接口约定:填充参数 > 生成签名 > 封装 HTTP 请求 > 发起 HTTP 请求 > 得到 HTTP 响应 > 解析响应结果。
接口规范
为防止 API 调用过程中被恶意篡改,调用任何一个 API 都需要携带签名,服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。
接口地址
正式环境 | http://wulianguanjia.cn:80/welcome |
---|---|
沙箱环境 | http://wulianguanjia.cn:80/welcome |
接口规范
传输方式 | HTTP |
---|---|
提交方式 | 为避免乱码问题,建议使用 POST 方式发起请求。 |
字符编码 | 统一采用 UTF-8 字符编码 |
签名算法 |
MD5 小写 32 位,示例:
内容:HelloWorld
摘要:68e109f0f40ca72a15e05cc22786f8e6
|
公共参数
参数 | 类型 | 必填? | 描述 |
---|---|---|---|
dev_id | String | 是 | 开发者标识 |
token | String | 是 | 令牌 |
sign | String | 是 | 参数签名 |
业务参数
API 调用除了必须包含公共参数外,如果 API 本身有业务级的参数也必须传入,每个 API 的业务参数请参考 API 清单说明。
令牌(token)生成方式
生成规则 | <时间戳> + <随机串>,长度在 15 ~ 64 位 |
---|---|
时间戳 | 格式:YYYYMMDDHHMISS ,示例:20180615093651 ,固定 14 位长度,时间戳与服务端时间误差在 5 分钟内有效 |
随机串 | 格式:由字母、数字、下划线组成,示例:154746710336556286 ,长度在 1 ~ 50 位,可使用 UUID 或 业务标记(ID,流水号等),随机串每自然天内不能重复 |
令牌示例 |
时间戳(timestamp):20180615093651
随机串(random):154746710336556286
令牌(token):
20180615093651154746710336556286 |
参数签名(sign)生成方式
生成规则 | MD5(<开发者标识> + <开发者密钥> + <令牌>),小写,固定 32 位长度 |
---|---|
开发者标识 | 系统生成,示例:b6c4be8865f94461b48cadd0bb130d21 ,建议定期更换。 |
开发者密钥 | 系统生成,示例:395be1cc04fb41878a07e553a754df2d ,建议定期更换。 |
签名示例 |
开发者标识(dev_id):b6c4be8865f94461b48cadd0bb130d21
开发者密钥(dev_key):395be1cc04fb41878a07e553a754df2d
令牌(token):20180615093651154746710336556286
签名(sign):MD5(
b6c4be8865f94461b48cadd0bb130d21395be1cc04fb41878a07e553a754df2d20180615093651154746710336556286 ) |
注意事项
1、为防止 API 调用过程中被恶意篡改,调用任何一个 API 都需要携带签名,服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。
2、所有的请求和响应数据编码皆为 UTF-8 格式, URL 里的所有参数名和参数值请做 UTF-8 编码。
3、参数名与参数值拼装起来的 URL 长度小于 1024 个字符时,可以用 GET 发起请求;拼装好的请求 URL 过长时,必须用 POST 发起请求。所有 API 都可以用 POST 发起请求。
4、为避免乱码问题,建议使用 POST 方式发起请求。
5、为保证帐户安全,建议绑定安全 IP 地址。
开始使用
从产品简介,购买指导,操作指南,API参考,SDK资源下载,助你快速部署。