接入流程

Hi,开发者您好!,欢迎使用云号科技开放平台。以下内容,是您接入服务的一些基本介绍,希望您能够在这里找到适合您业务项目,感谢您的使用!

请求形式

接口协议使用HTTP,为发起方提供访问的URL规范,发起方使用HTTP 【POST】方法发送请求报文并得到应答报文。

交互编码

双方交互内容发送的格式均为UTF-8。

超时设置

外围与开放平台之间交互同步等待超时时间建议最大超时时间设置为5秒。

签名机制

调用接口时需要对请求参数进行签名验证,服务器也会对该请求参数进行验证是否合法的。

签名方法

调用接口时,请先调用获取token接口,获取用户token,然后在后续调用接口中将token回传。

公共参数

请求地址:登录后可见

公共请求参数:

参数 类型 描述 是否必须
a int 用户标识,例如:108 Y
fun string 接口名称,例如:GetTelArea Y
token string 例如:1d0c8485f4e5e1f5406c8a4a4ccb968d Y

公共返回参数:

参数 类型 描述 是否必须
data json 接口具体返回内容 Y
state int 请求接口状态 Y
msg string 附加消息,无实际意义 Y
补充说明

缩略语与名词解释:

简称/术语 对应参数 说明
apiID a 接口ID,调用接口时用于鉴权
apikey apikey 接口Key,调用接口时用于鉴权
token c 根据指定的签名规则,为报文设置签名

HTTP状态码一览表:

状态码 说明
-101 未知
-2** 无权限
-201 账号不存在
-202 用户调用接口权限已过期
-203 无调用接口权限
-3** 上传参数异常
-301 调用接口名无效
-302 缺少参数
-303 参数错误
-304 签名有误