约定说明

接口地址及密钥:

  1. 接口地址: {{$config['api_url']}}
  2. 密钥: 线下发送

接口基本格式:

{{if isset($config['use_nonce']) && $config['use_nonce']}} {{/if}}
类型 数据 是否必选 说明
数据格式 Application/json Y http 数据类型
请求方法 POST Y http发送方法
请求内容 system version Y {{$version}}
sign Y md5(key+time) 签名
time Y UTC 时间戳, 自 1970 年 1 月 1 日起计算的时间，单位为秒
from Y 来源,跟密钥相对应，线下发送
nonce Y 唯一的不重复的随机串
method 1-1 Y 方法
params 详细的参数
请求示例:

在本示例中请求的是V1版本的接口。来源是ios。请求的接口是1-1。参数有3个分别是username、password、nickname
                            
{
    "system": {
        "version":"V1",
        "from": "ios",
        "sign": "a101f236d049b9ad80e012113e59f9bc",
{{if isset($config['use_nonce']) && $config['use_nonce']}}
        "nonce": "1445482366:fdoielnx",
{{/if}}
        "time": "1445482366"
    },
    "method": "1-1",
    "params": {
        "username" : "test001@163.com",
        "password" : "123456",
        "nickname" : "我是测试账号1"
    }
}

其它约定:

    {{loop $config['convention_desc'] $ctitle $cdesc}}
  1. {{$ctitle}}: {{$cdesc}}
    2. {{/loop}}

响应code说明:

{{loop $config['code'] $code $means }} {{/loop}}
code 说明
{{$code}} {{$means}}

接口定义

{{loop $result $version $item }}

版本: {{$version}}

{{loop $item $method $api }}

{{$method}}：{{$api['desc']}}

接口定义：
{{loop $api['params'] $pk $pv }} {{if $pk == 0}} {{/if}} {{/loop}}
字段名 格式 是否必填 说明
params{{$pv[1]}} {{$pv[0]}} {{$pv[3]}} {{$pv[2]}}

代码示例:

Request:

{{$api['req']}}

Response:

成功
{{$api['success']}}
失败
{{$api['error']}}
{{/loop}} {{/loop}}