开放平台 / 概述 / 1.2 接口规范

1.2 接口规范

1.2.1    输入输出格式


采取JSON形式,对于输出内容的数据类型,包括:

布尔型(boolean):例如isNew:true|false,没有null值

数字型(int):例如number:3.1415,未设置时值为0

数字型(double):例如number:3.1415,未设置时值为0

字符串型(String):例如name:’张三’,没有null值,null需要转化为’’(空串)

对象类型(Object):null表示空对象,{…}表示非空对象【只有Object有null值】,对象的属性可以是boolean,int,double ,String,Object,Array, ArrayList.

数组与集合类型(Array, ArrayList,HashMap):则[]表示空数组或集合。

    没有null值,null需要转换为[],数组的元素可以是boolean,int,double ,String,Object,Array,ArrayList.HashMap。


1.2.2    返回结果统一规范

    通用输出值的格式具体如下

    {

        result: 1成功 2错误 3警告

        success:true|false,   //是否成功,boolean

        code:0,   //错误代码,用于错误的分类,int

        msg: //错误消息,成功时为null,失败时返回错误信息

        data:  //返回值,Object

    }


    对于返回的结果,有以下几种情况:

    • success=true:成功,此时errorCode=0,代表没有错误。其中data为返回的数据对象。data只可能是Object或Array类型。

    • success=false:失败,进一步查看errorCode确定错误的分类以确定下一步操作。对于每个接口来说,errorCode的情况可能都不一样,具体说明见各个接口。

    

    httpcode 输出值 说明

    0 正常预期返回

    1001 Miss key 客户端没传递key

    1002 Invalid key 客户端传递的key 值非法

    1003 Invalid access token 客户端传递的token非法:伪造或过期

    1004 Invalid signature signature签名验证错误

    

 

对上述401类返回,建议客户端直接跳转至登陆页让用户进行重新登陆;


1.2.3    授权域名

    https://api.wojiacloud.com   请使用 https接入, http不保证可用


1.2.4    头信息

    所有接口需要传入 Head信息,格式如下

 

    参数 说明 类型 是否必须

    appKey App Key String Y 开发者账号创建授权接入

    clientTime 访问时间毫秒数 Int Y在30分钟内有效

    version 客户端版本 String Y   固定值V1.0

    signature 签名串 String Y


     签名串生成规则见1.4.1签名算法