6. 标识相关接口

6.1 标识列表

已添加的标识列表，每页固定大小10条

6.1.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：GET
• 请求路径：/api/identity/list
• Header:

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Param:

参数	类型	是否必填	最大长度	备注	示例值
page	int	是	-	页码	1

6.1.2 请求示例

/api/identity/list?page=1

6.1.3 响应参数

• 公共响应参数

参数	类型	最大长度	备注	示例值
code	Integer	-	状态码	"000"
message	String	-	状态码描述	"操作成功"
data	Object	-	返回数据格式

• 响应参数

参数	类型	最大长度	备注	示例值
result	Array	-	数据
result[i].handleId	String	-	标识id	M6T0S4
result[i].prefix	String	-	前缀	88.488.xxx
result[i].handle	String	-	标识	88.488.105/zxxsh-sdhfs-s
result[i].create	String	-	创建时间	2023-06-02 12:00:45
result[i].update	String	-	更新时间	2023-06-02 12:00:45
pager	Object	-	页码信息
pager.page	int	-	页码	1
pager.pageSize	int	-	页码大小	10
pager.total	int	-	总数	1
pager.totalPage	int	-	总页数	1

6.1.4 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": {
    "result": [
      {
        "handleId": "M6T0xxxx",
        "prefix": "88.488.xxx",
        "handle": "88.488.105/xxxxxxx",
        "create": "2023-06-02 12:00:45",
        "update": "2023-06-02 12:00:45"
      }
    ],
    "pager": {
      "page": 1,
      "pageSize": 10,
      "total": 1,
      "totalPage": 1
    }
  }
}}

6.1.5 异常示例

{
  "code": "002",
  "succ": false,
  "msg": "token失效",
  "data": []
}

6.2 标识详情

6.2.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：GET
• 请求路径：/api/identity/detail
• Header:

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Param:

参数	类型	是否必填	最大长度	备注	示例值
handleId	String	是	255	要查询的标识	"88.709.911/xxxxx"

6.2.2 请求示例

/api/identity/detail?handleId=M6T1S1

6.2.3 响应参数

• 公共参数

参数	类型	最大长度	备注	示例值
code	String	-	状态码	000
msg	String	-	状态码描述	操作成功
data	Object	-	返回数据（如下）

• 响应参数

参数	类型	最大长度	备注	示例值
handleId	String
标识id	M6T1S1
prefix	String	-	前缀	88.488.xxxx
handle	String	-	标识	88.488.xxxx/016xxxxx520a8a0
templateVersion	String	-	模板版本	旺旺2.0
value	Array	-	标识属性	-
value[i].auth	String	-	权限码，预留字段	-
value[i].index	Int	-	标识属性索引	2000
value[i].type	String	-	标识属性类型	name
value[i].data	Object
标识属性内容
value[i].data.format	String	-	标识属性内容格式（现只支持string）	string
value[i].data.value	String	-	标识属性内容值	标识属性内容

6.2.4 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": {
    "handleId": "M6T1S1",
    "prefix": "88.488.xxx",
    "handle": "88.488.xxxx/xxxxxx",
    "templateVersion": "模板版本",
    "value": [
      {
        "data": {
          "format": "string",
          "value": "xxxxxxx"
        },
        "index": 2000,
        "type": "name"
      },
      {
        "data": {
          "format": "string",
          "value": "NWW\_00001"
        },
        "index": 2001,
        "type": "number"
      }
    ]
  }
}

6.2.5 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "标识id 参数缺失",
  "data": []
}

• 常见错误见附录

6.3 标识查询

6.3.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：GET
• 请求路径: /api/identity/query
• Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Param:

参数	类型	是否必填	最大长度	备注	示例值
handle	String	是	255	要查询的标识	"88.709.911/123"

6.3.2 请求示例

/api/identity/query?handle=88.488.105/xxxxxxxxx

6.3.3 响应参数

• 公共响应参数

参数	类型	最大长度	备注	示例值
code	String	-	状态码	"000"
msg	String	-	状态码描述	"操作成功"
data	Object	-	返回数据

• 响应参数

参数	类型	最大长度	备注	示例值
prefix	String	-	前缀	88.488.105
handle	String	-	标识	88.488.105/01645caae10520a8a0
templateVersion	String	-	模板版本	模板版本
value	Array	-	标识属性	-
value[i].auth	String	-	权限码，预留字段	-
value[i].index	Int	-	标识属性索引	2000
value[i].type	String	-	标识属性类型	name
value[i].data	Object		标识属性内容
value[i].data.format	String	-	标识属性内容格式（现只支持string）	string
value[i].data.value	String	-	标识属性内容值	标识属性内容值

6.3.4 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": {
    "prefix": "88.488.xxx",
    "handle": "88.488.xxx/xxxxxxxxxx",
    "templateVersion": "模板版本",
    "value": [
      {
        "data": {
          "format": "string",
          "value": "xxxxx"
        },
        "index": 2000,
        "type": "name"
      },
      {
        "data": {
          "format": "string",
          "value": "NWW\_00001"
        },
        "index": 2001,
        "type": "number"
      }
    ]
  }
}

6.3.5 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "标识参数缺失",
  "data": []
}

• 常见错误见附录

6.4 注册标识

6.4.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：POST
• 请求路径：/api/identity/create
• Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Body:

参数	类型	是否必填	最大长度	备注	示例值
handle	String	是	255	要注册的标识(格式：前缀 + '/' + 自定义编号)	88.488.105/zxxsh-sdhfs-s
templateVersion	String	是	128	模板版本	"模板版本"
value	Array	是	-	标识属性	-
value[i].index	Int	是	11	标识属性索引	2000
value[i].data	Object	是	-	标识属性内容	-
value[i].data.format	String	是	-	标识属性内容格式（现只支持string）	"string"
value[i].data.vlaue	String	是	255	标识属性内容值	"xxxxxx"
value[i].data.type	String	是	128	标识属性类型（数据模板的：idType）	"name"

6.4.2 请求示例

{
  "handle": "88.488.105/zxxsh-sdhfs-s",
  "templateVersion": "xxxx2.0",
  "value": [
    {
      "data": {
        "format": "string",
        "value": "xxxxx"
      },
      "index": 2000,
      "type": "name"
    },
    {
      "data": {
        "format": "string",
        "value": "NWW\_00001"
      },
      "index": 2001,
      "type": "number"
    }
  ]
}

6.4.3 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": []
}

6.4.4 异常示

{
  "code": "001",
  "succ": false,
  "msg": "非法操作，索引1000在模板中不存在",
  "data": []
}

6.4.5 注意事项

• value中数据是对应模板版本的数据格式
• 标识属性内容格式，即value[i].format暂时只支持string
• 接口会根据templateVersion获取定义的元数据模板来限制注册数据
• index和type必须和模板中的保持一致
• 模板index和type请在业务系统的"标识注册-数据模板-详情"页面中获取

6.5 批量注册标识

6.5.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式:POST
• 请求路径：/api/identity/batchCreate
• Header:

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Body：

参数	类型	是否必填	最大长度	备注	示例值
params	Array	是	-	批量数据,参考：（单个请求的参数，保持一致）

6.5.2 请求示例

{
  "params": [
    {
      "handle": "88.488.105/zxxsh-sdhfs-s5",
      "templateVersion": "xxxx2.0",
      "value": [
        {
          "data": {
            "format": "string",
            "value": "xxxxxxxxx"
          },
          "index": 2000,
          "type": "name"
        },
        {
          "data": {
            "format": "string",
            "value": "NWW\_00005"
          },
          "index": 2001,
          "type": "number"
        }
      ]
    },
    {
      "handle": "88.488.xxx/xxxxxxxxxx",
      "templateVersion": "xxxx2.0",
      "value": [
        {
          "data": {
            "format": "string",
            "value": "xxxxxxxxxxxxxx"
          },
          "index": 2000,
          "type": "name"
        },
        {
          "data": {
            "format": "string",
            "value": "NWW\_00006"
          },
          "index": 2001,
          "type": "number"
        }
      ]
    }
  ]
}

6.5.3 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": []
}

6.5.4 异常示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": [ //存在错误未注册成功的
    {
      "handle": "88.488.105/zxxsh-sdhfs-s6",
      "msg": "标识已存在"
    }
  ]
}

6.5.5 注意事项

• value中数据是对应模板版本的数据格式
• 标识属性内容格式，即value[i].format暂时只支持string
• 接口会根据templateVersion获取定义的元数据模板来限制注册数据
• 批量注册最大支持1000条，超出则给出提示信息
• 单并发下，推荐每次批量注册100-1000个标识

6.6 更新标识

6.6.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：POST
• 请求路径：/api/identity/update
• Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Body：

参数	类型	是否必填	最大长度	备注	示例值
handleId	String	是	-	标识id	M6T4S3
handle	String	是	255	注册的标识(格式：前缀 + '/' + 自定义编号)	88.488.105/zxxsh-sdhfs-s
templateVersion	String	是	128	模板版本	"xxxxx2.0"
value	Array	是	-	标识属性	-
value[i].index	Int	是	11	标识属性索引	2000
value[i].data	Object	是	-	标识属性内容	-
value[i].data.format	String	是	-	标识属性内容格式（现只支持string）	"string"
value[i].data.vlaue	String	是	255	标识属性内容值	"xxxxxxx"
value[i].data.type	String	是	128	标识属性类型（数据模板的：idType）	"name"

6.6.2 请求示例

{
  "handleId": "M6T4S3",
  "handle": "88.488.xxx/xxxxxxxxxxxx",
  "templateVersion": "xxxx2.0",
  "value": [
    {
      "data": {
        "format": "string",
        "value": "xxxxxxxxxxxxxx"
      },
      "index": 2000,
      "type": "name"
    },
    {
      "data": {
        "format": "string",
        "value": "NWW\_00001"
      },
      "index": 2001,
      "type": "number"
    }
  ]
}

6.6.3 响应参数

同注册标识

6.6.4 响应示例

同注册标识

6.6.5 异常示例

同注册标识

6.6.6 注意事项

同注册标识

6.7 批量更新标识

6.7.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：POST
• 请求路径：/api/identity/batchUpdate
• Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Body：

参数	类型	是否必填	最大长度	备注	示例值
params	Array	是	-	批量数据,请参考（单个请求的格式，保持一致）

6.7.2 请求示例

{
  "params": [
    {
      "handleId": "M6T4S3",
      "handle": "88.488.105/zxxsh-sdhfs-s2",
      "templateVersion": "xxx2.0",
      "value": [
        {
          "data": {
            "format": "string",
            "value": "xxxxxxx"
          },
          "index": 2000,
          "type": "name"
        },
        {
          "data": {
            "format": "string",
            "value": "NWW\_00001"
          },
          "index": 2001,
          "type": "number"
        }
      ]
    },
    {
      "handleId": "M6T3S8",
      "handle": "88.488.xxx/xxxxxxxxxxxxx",
      "templateVersion": "xxxx2.0",
      "value": [
        {
          "data": {
            "format": "string",
            "value": "xxxxxxxxxxxxx"
          },
          "index": 2000,
          "type": "name"
        },
        {
        "data": {
          "format": "string",
          "value": "NWW\_00001"
        },
          "index": 2001,
          "type": "number"
        }
      ]
    }
  ]
}

6.7.3 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": [] // 根据dota进行判断
}

6.7.4 异常示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": [ //未更新成功的
    {
      "handleId": "M6T3S8",
      "handle": "88.488.105/zxxsh-sdhfs-s3",
      "msg": "标识不存在"
    }
  ]
}

6.7.5 注意事项

同批量注册标识

6.8 删除标识

6.8.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：POST
• 请求路径:/api/identity/del
• Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Body：

参数	类型	是否必填	最大长度	备注	示例值
handleId	String	是	255	要删除的标识Id	M6T4S4

6.8.2 请求示例

{
  "handleId": "M6T4S4"
}

6.8.3 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": []
}

6.8.4 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "未找到标识id",
  "data": []
  }

• 常见的错误见附录

6.9 批量删除标识

6.9.1 请求参数

• 请求服务：服务器的HTTP端口
• 请求方式：POST
• 请求路径：/api/identity/batchDel
• Header:

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

• Body:

参数	类型	是否必填	最大长度	备注	示例值
params	Array	是	-	批量数据（里面元素和单个请求格式一样）

6.9.2 请求示例

{
  "params": ["M6T1S8", "M6T1S7"]
}

6.9.3 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": []
}

6.9.4 异常示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": [ //存在未删除成功的
    {
      "handleId": "M2C9S2",
      "msg": "未找到标识id"
    }
  ]
}

6.9.5 注意事项

• 批量删除最大支持1000条，超出则给出提示信息
• 单并发下，推荐每次批量删除100-1000个标识