锐捷网络API文档说明

锐捷网络API文档说明

API ROOT: https://apis.ruijie.com.cn/api

基于restful设计
增加auth2.0认证
增加访问限制，如每小时请求次数

Alt text

获取授权

使用申请/分配的APPID及APPKEY获取授权token，过期需重新获取。

URL: https://apis.ruijie.com.cn/oauth/token
需要授权: [否]
请求类型: [POST]
Post数据格式[application/json]:
strictSSL: false

    url: 'https://apis.ruijie.com.cn/oauth/token',
    {
        "grant_type":"password",
        "client_id": "appid",
         "client_secret":"appkey",
        "username":"username",
        "password":"userpassword",
        "scope":"demo"
    }

参数说明
［测试帐号请联系sunxiaobo@ruijie.com.cn］
- “grant_type”:password密码模式,
- client_id: 申请的appid
- client_secret: 申请的appkey
- “username”:用户名,
- “password”:用户密码,
- “scope”:”demo” 授权域
授权响应 [POST]
- Response 200 (application/json)

    { 
        access_token: 'xxxx',
        expires_in: 1209600,
        refresh_token: 'xxx',
        token_type: 'Bearer' 
    }

返回数据说明
- access_token:请求API授权码，调用api必要参数
- expires_in: 有效期，单位秒，过期后需要重新获取
- refresh_token: 用户刷新access_token，token过期换取新token的必要参数
- token_type: Access Token 类型 [本版本可以忽略,后续版本扩展使用]

过期token换取新token

token过期需重新换取。

URL: https://apis.ruijie.com.cn/oauth/token
需要授权: [是]
请求类型: [POST]
Post数据格式[application/json]:
strictSSL: false

    url: 'https://apis.ruijie.com.cn/oauth/token',
     {
        "grant_type": "refresh_token",
        "client_id": "your clientid",
        "client_secret": "appkey",
        "refresh_token": "***********"
     }

参数说明
［测试帐号请联系sunxiaobo@ruijie.com.cn］
- “grant_type”:refresh_token［固定参数］换取新token,
- client_id: 申请的appid
- client_secret: 申请的appkey
- “refresh_token”: 上次获取token中反馈的refresh_token
换取响应 [POST]
- Response 200 (application/json)

    {
        "access_token": "xN2836yQAQfDURxVPds0IM9vfUk3IJC5",
        "expires_in": 604800,
        "scope": "demo",
        "refresh_token": "VFlAp82EUWNQJkokRvoELSPhPpO3pSPS",
        "token_type": "Bearer"
    }

返回数据说明
- access_token:请求API授权码，调用api必要参数
- expires_in: 有效期，单位秒，过期后需要重新获取
- “scope”: “demo”,作用域，正式时会更换
- refresh_token: 用户刷新access_token，token过期换取新token的必要参数,
- token_type: Access Token 类型 [本版本可以忽略,后续版本扩展使用]

用户API (新版)

返回结果结构：


{
"status": 1,
"code": "",
"message":"",
"data":{}
}

status:请求成功或者失败,（必须返回1:成功, 0:失败）
code:”错误码”,（status为1时，该值可忽略，请参见:Link）
message:”错误码对应中文描述”, （status为1时，该值可忽略）
data:”如需要返回数据结果的内容,如Get请求用户信息”（status为1且请求为GET时，解析该内容，目前仅获取用户信息接口有值）

服务器返回有关错误信息以及消息代码,请参见:Link

注册

用户注册API,用户信息可以选填.

uri: /account
需要授权: [是],授权参见：Link
请求类型: [POST]
Post数据格式(application/json):


    //手机注册-生成新用户. code为获取到的验证码
    {   
            "code" : "validate code",
            "username":"your name ",
            "password": "your password",
            "mobile":"your mobile number",
            ...
    }
    //邮箱注册
    {   
            "email":"your email",
            "username":"your name ",
            "password": "your password",
    }

参数说明
- data:用户Json对象,详情见:LINK
- 注意: 手机号码信息只允许手机注册时保存或手机绑定时进行保存, 邮箱注册时手机非必填，但填写的话需要验证唯一且需要验证码才可以注册成功
备注
- 手机注册请注意先获取验证码再注册.邮箱暂不需激活验证
- 用户资料中
请求实例：

邮箱注册：
    curl -i -X POST \
    -H "Content-Type:application/json" \
    -d \
    '{
            "username": "panyuntao19",
            "email": "panyuntao19@ruijie.com.cn",
            "password": "777777",
            "idcardtype": "身份证",
            "idcard": "1234566",
            "resideprovince": "江西省",
            "residecity": "萍乡市",
            "residedist": "区",
            .......其他.....
    }' \
 'https://apis.ruijie.com.cn/api/account?access_token=your access token'

手机注册:

    curl -i -X POST \
    -H "Content-Type:application/json" \
    -d \
    '{
            "username": "panyuntao15",
            "mobile": "13401183771",
            "code":"6804",
            "password": "777777",
            "fax": "115457"

    }' \
    'https://apis.ruijie.com.cn/api/account?access_token=your access token'

更新用户资料(完整更新)

更新用户资料API.此API仅可以更改用户资料API，但是不可以更改用户帐号信息.例如密码、用户名

uri: account/{id}
需要授权: [是],授权参见：Link
请求类型: [Put]
Put数据格式(application/json):

    {   
            "realname":"your realname",
            "birthyear":"your birthyear ",
            "birthmonth": "your birthmonth",
            "birthday":"your birthday",
            "company":"your company",
            ...
    }

参数说明
- URL参数{ID}值对应为 username、email中的一项
- 用户数据Json对象,详情见:LINK
请求实例：

    curl -i -X PUT \
     -H "Content-Type:application/json" \
    -d \
    '{
            "realname": "测试",
            "birthyear": "2003",
            "birthmonth": "2",
        ... 其他...
    }' \
    'https://apis.ruijie.com.cn/api/account/panyuntao19?access_token=your access token'

更新用户资料(部分更新)

更新用户资料API.此API仅可以更改用户资料API，但是不可以更改用户帐号信息.例如密码、用户名

uri: account/{id}
需要授权: [是],授权参见：Link
请求类型: [Patch]
Patch数据格式(application/json):

    {   
            "realname":"your realname",
            "birthyear":"your birthyear ",
            "birthmonth": "your birthmonth",
            "birthday":"your birthday",
            "company":"your company",
            ...
    }

参数说明
- URL参数{ID}值对应为 username、email中的一项
- 用户数据Json对象,详情见:LINK
备注
用户信息字段可以选填,如果不在data中,那么此字段不更新.否则即使为空串也将会更新入库.
请求实例：

    curl -i -X Patch \
     -H "Content-Type:application/json" \
    -d \
    '{
            "realname": "测试",
            "birthyear": "2003",
            "birthmonth": "2",
        ... 其他...
    }' \
    'https://apis.ruijie.com.cn/api/account/panyuntao19?access_token=your access token'

删除用户

删除用户的API,慎用.

url: /account/{id}
需要授权: [是],授权参见：Link
请求类型: [Delete]
备注:此操作将会删除用户,请慎用.
请求实例：

    curl -i -X DELETE \
     -H "Content-Type:application/json" \
    'https://apis.ruijie.com.cn/api/account/panyuntao11?access_token=your access token'

获取用户信息

uri: account/{id}
需要授权: [是],授权参见：Link
请求类型: [Get]
返回数据格式(application/json):

    {
    "username": "user's name",
    "email": "user's email",
    "mobile": "user's mobile",
    "realname": "user's realname",
    "idcardtype": "user's idcard type",
    "birthyear": 0,
    "birthmonth": 0,
    "birthday": 0,
    ...
    }

URL参数{ID}值对应为 username、email中的一项
备注:用户数据对应字段参见:LINK
请求实例：

    curl -i -X GET \
     -H "Content-Type:application/json" \
     'https://apis.ruijie.com.cn/api/account/panyuntao19?access_token=your access token'

通过邮箱/手机重置密码

重置密码的API

uri: account/password
需要授权: [是],授权参见：Link
请求类型: [Post]
Post数据格式(application/json):

{
  "email":"your email",
  "code":"validate code",
  "newpassword":"your new password"
}

或

{
  "mobile":"your mobile",
  "code":"validate code",
  "newpassword":"your new password"
}

参数说明
- email:将要接收验证码的email地址
- mobile:将要接收验证码的移动电话号码
请求实例：

    curl -i -X POST \
    -H "Content-Type:application/json" \
    -d \
    '{
    "email":"panyuntao@ruijie.com.cn",
    "code":"1234",
    "newpassword":"password"
    }' \
    'https://apis.ruijie.com.cn/api/account/password?access_token=your access token'

通过用户原密码修改密码

依据用户正确的原密码修改新的密码

uri: account/password2
需要授权: [是],授权参见：Link
请求类型: [Post]
Post数据格式(application/json):

{
  "username":"your email/username",
  "password":"your old password",
  "newpassword":"your new password"
}

参数说明
- username:用户的邮箱或者用户名
- password:当前的密码
- newpassword:用户的新密码
请求实例：

    curl -i -X POST \
    -H "Content-Type:application/json" \
    -d \
    '{
        "username":"panyuntao",
        "password":"Qq123456",
        "newpassword":"Qq123456"
    }' \
    'https://apis.ruijie.com.cn/api/account/password2?access_token=your access token'

手机号码绑定

uri: /account/mobilebinding
需要授权: [是],授权参见：Link
请求类型: [POST]
Post数据格式(application/json):

    {
        "username":"your user identity",
        "mobile":"your mobile",
        "code": "your code"
    }

参数说明
- username: 登录帐号，支持帐号名及帐号邮箱
- mobile: 绑定手机号
- code:手机收到的验证码
请求实例：

    curl -i -X POST \
    -H "Content-Type:application/json" \
    -d \
    ' {
        "username":"panyuntao",
        "mobile":"13910661542",
        "code": "2345"
    }' \
 'https://apis.ruijie.com.cn/api/account/mobilebinding?access_token=your access token'

邮箱绑定

uri: /account/emailbinding
需要授权: [是],授权参见：Link
请求类型: [POST]
Post数据格式(application/json):

    {
        "username":"your user identity",
        "email":"your email",
        "code": "your code"
    }

参数说明
- username: 登录帐号，支持帐号名及帐号邮箱
- email: 绑定邮箱
- code:邮箱收到的验证码

手机号码解除绑定

uri: /account/mobileunbinding
需要授权: [是],授权参见：Link
请求类型: [POST]
Post数据格式(application/json):

    {
        "username":"your user identity"
    }

参数说明
- username: 登录帐号，支持帐号名及帐号邮箱

获取验证码

获取用户验证码的API

url: /account/safecode
需要授权: [是],授权参见：Link
请求类型: [Post]
Post数据格式(application/json):

    {
      "email":"your email address"
    }

或

    {
      "mobile":"your mobile number"
    }

参数说明
- email:将要接收验证码的email地址
- mobile:将要接收验证码的移动电话号码
请求实例：

    curl -i -X POST \
    -H "Content-Type:application/json" \
    -d \
    '{
        "mobile": "your mobile"
    }' \
    'https://apis.ruijie.com.cn/api/account/safecode?access_token=your access token'

验证用户账户关键字

uri: account/checking
需要授权: [是],授权参见：Link
请求类型: [Post]
Post数据格式(application/json):

{
    "type":3,
    "code":"validation content",
    "userid":"" //此字段选填,仅在检查类型为4、5的时候必须填写.
}

参数说明
- type: 1为验证用户名、2为验证邮箱、3为验证手机号码、4为验证除自己外的email、5为验证除自己外的手机号码
- code:需要验证的值.
- userid:账号名称或邮箱.
请求实例：

    curl -i -X POST \
    -H "Content-Type:application/json" \
    -d \
    '{
        "type":1,
        "code":"panyuntao"
    }' \
    'https://apis.ruijie.com.cn/api/account/checking?access_token=your access token'