菜单

证书对外开放接口

注意：所有API接口需携带协会易分发的appId和secret。

1、证书详情

允许第三方通过此接口获取颁发证书的详情。

URL：https://www.shanghuiyi.com/open/cert/detail?appId=xxx&secret=xxx

Method：GET

请求参数

参数	类型	说明
certId	int	对应协会易后台证书模板的id

请求示例

https://www.shanghuiyi.com/open/cert/detail?certId=xxx&appId=xxx&secret=xxx

成功响应

条件：请求参数合法。

状态码：0

响应示例：响应将会返回证书的字段信息：

{
  "data": [
    {
      "id": "6551427978502144",
      "name": "证书编号"
    },
    {
      "id": "6551427978633222",
      "name": "证书等级",
      "levels": [
        {
          "levelName": "无等级",
          "levelValue": 1
        },
        {
          "levelName": "十六级棋士",
          "levelValue": 2
        },
        {
          "levelName": "十五级棋士",
          "levelValue": 3
        },
        {
          "levelName": "十四级棋士",
          "levelValue": 4
        },
        {
          "levelName": "十三级棋士",
          "levelValue": 5
        },
        {
          "levelName": "十二级棋士",
          "levelValue": 6
        },
        {
          "levelName": "十一级棋士",
          "levelValue": 7
        },
        {
          "levelName": "十级棋士",
          "levelValue": 8
        },
        {
          "levelName": "九级棋士",
          "levelValue": 9
        },
        {
          "levelName": "八级棋士",
          "levelValue": 10
        },
        {
          "levelName": "七级棋士",
          "levelValue": 11
        },
        {
          "levelName": "六级棋士",
          "levelValue": 12
        },
        {
          "levelName": "五级棋士",
          "levelValue": 13
        },
        {
          "levelName": "四级棋士",
          "levelValue": 14
        },
        {
          "levelName": "三级棋士",
          "levelValue": 15
        },
        {
          "levelName": "二级棋士",
          "levelValue": 16
        },
        {
          "levelName": "一级棋士",
          "levelValue": 17
        },
        {
          "levelName": "地方大师",
          "levelValue": 18
        },
        {
          "levelName": "棋协大师",
          "levelValue": 19
        },
        {
          "levelName": "国家大师",
          "levelValue": 20
        },
        {
          "levelName": "特级大师",
          "levelValue": 21
        }
      ]
    },
    {
      "id": "6551427978502145",
      "name": "姓名"
    },
    {
      "id": "6551427978502146",
      "name": "性别"
    },
    {
      "id": "6551427978502147",
      "name": "个人证件照"
    },
    {
      "id": "6551427978633216",
      "name": "身份证号"
    },
    {
      "id": "6551427978633217",
      "name": "发证机关"
    },
    {
      "id": "6551427978633218",
      "name": "发证日期"
    },
    {
      "id": "6551427978633220",
      "name": "证书图片"
    }
  ],
  "errmsg": "成功",
  "errno": 0
}

返回参数说明

参数名	说明
errmsg	状态描述
errno	状态码
data	接口返回数据

data数据说明

属性	类型	说明
id	string	证书字段的id
name	string	证书字段的名字，中文汉字

“证书等级”字段会携带一个含所有等级的数组，数组中的对象levelValue值越大代表等级越高，可根据用户信息接口中的certLevel信息获取到当前用户晋级后的等级，取下一顺位即可。其他字段含义，可参见下方硬编码。

错误响应

条件：请求参数非法。

状态码：-1

{
    "errmsg": "请求错误",
    "errno": -1
}

2、证书上传

允许第三方通过此接口给用户颁发证书。

URL：https://www.shanghuiyi.com/open/cert/certUpload?appId=xxx&secret=xxx

Method：POST

请求参数

参数	类型	约束
certId	int	整型,固定值392
certInfos	array	对象数组

certInfo详情：

属性	类型	说明
title	string	证书字段名
value	string	证书字段对应的值

请求示例

https://www.shanghuiyi.com/open/activity/certAward?appId=xxx&secret=xxx

Content-Type: application/json

{
"certId": xxx,
"certInfos": [
        {
        "title": "xxx",
        "value": "xxx"
        },
        {
        "title": "xxx",
        "value": "xxx"
        }
    ]
}

成功响应

条件：请求参数合法。

状态码：0

响应示例：

{
    "errmsg": "请求错误",
    "errno": -1
}

返回参数说明

参数名	说明
errmsg	状态描述
errno	状态码

错误响应

条件：请求参数非法。

状态码：-1

{
    "errmsg": "请求错误",
    "errno": -1
}

3、删除证书

通过此接口可删除已上传的证书

URL：https://www.shanghuiyi.com/open/cert/certDelete?appId=xxx&secret=xxx

Method：POST

请求参数

参数	类型	说明
certId	int	对应协会易系统内证书模板id
certNo	string	证书编号

请求示例

https://www.shanghuiyi.com/open/cert/certDelete?certId=xxx&certNo=xxx&appId=xxx&secret=xxx

成功响应

条件：请求参数合法。

状态码：0

响应示例：响应将会返回证书的字段信息：

{
    "errmsg": "成功",
    "errno": 0
}

返回参数说明

参数名	说明
errmsg	状态描述，如若有异常则为异常提示信息
errno	状态码，0-成功，其余为异常状态

上一个

活动对外开放接口

最近修改: 2024-11-13Powered by

大纲