6. 標識相關(guān)接口

6.1 標識列表

已添加的標識列表，每頁(yè)固定大小10條

6.1.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：GET
請求路徑：/api/identity/list
Header:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Param:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
page	int	是	-	頁(yè)碼	1

6.1.2 請求示例

/api/identity/list?page=1

6.1.3 響應參數

公共響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
code	Integer	-	狀態(tài)碼	"000"
message	String	-	狀態(tài)碼描述	"操作成功"
data	Object	-	返回數據格式

響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
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	-	創(chuàng )建時(shí)間	2023-06-02 12:00:45
result[i].update	String	-	更新時(shí)間	2023-06-02 12:00:45
pager	Object	-	頁(yè)碼信息
pager.page	int	-	頁(yè)碼	1
pager.pageSize	int	-	頁(yè)碼大小	10
pager.total	int	-	總數	1
pager.totalPage	int	-	總頁(yè)數	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 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：GET
請求路徑：/api/identity/detail
Header:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Param:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
handleId	String	是	255	要查詢(xún)的標識	"88.709.911/xxxxx"

6.2.2 請求示例

/api/identity/detail?handleId=M6T1S1

6.2.3 響應參數

公共參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
code	String	-	狀態(tài)碼	000
msg	String	-	狀態(tài)碼描述	操作成功
data	Object	-	返回數據（如下）

響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
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	-	標識屬性類(lèi)型	name
value[i].data	Object
標識屬性?xún)热?/td>
value[i].data.format	String	-	標識屬性?xún)热莞袷剑ìF只支持string）	string
value[i].data.value	String	-	標識屬性?xún)热葜?/td>	標識屬性?xún)热?/td>

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": []
}

常見(jiàn)錯誤見(jiàn)附錄

6.3 標識查詢(xún)

6.3.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：GET
請求路徑: /api/identity/query
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Param:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
handle	String	是	255	要查詢(xún)的標識	"88.709.911/123"

6.3.2 請求示例

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

6.3.3 響應參數

公共響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
code	String	-	狀態(tài)碼	"000"
msg	String	-	狀態(tài)碼描述	"操作成功"
data	Object	-	返回數據

響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
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	-	標識屬性類(lèi)型	name
value[i].data	Object		標識屬性?xún)热?/td>
value[i].data.format	String	-	標識屬性?xún)热莞袷剑ìF只支持string）	string
value[i].data.value	String	-	標識屬性?xún)热葜?/td>	標識屬性?xún)热葜?/td>

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": []
}

常見(jiàn)錯誤見(jiàn)附錄

6.4 注冊標識

6.4.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：POST
請求路徑：/api/identity/create
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
handle	String	是	255	要注冊的標識(格式：前綴 + '/' + 自定義編號)	88.488.105/zxxsh-sdhfs-s
templateVersion	String	是	128	模板版本	"模板版本"
value	Array	是	-	標識屬性	-
value[i].index	Int	是	11	標識屬性索引	2000
value[i].data	Object	是	-	標識屬性?xún)热?/td>	-
value[i].data.format	String	是	-	標識屬性?xún)热莞袷剑ìF只支持string）	"string"
value[i].data.vlaue	String	是	255	標識屬性?xún)热葜?/td>	"xxxxxx"
value[i].data.type	String	是	128	標識屬性類(lèi)型（數據模板的：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中數據是對應模板版本的數據格式
標識屬性?xún)热莞袷?，即value[i].format暫時(shí)只支持string
接口會(huì )根據templateVersion獲取定義的元數據模板來(lái)限制注冊數據
index和type必須和模板中的保持一致
模板index和type請在業(yè)務(wù)系統的"標識注冊-數據模板-詳情"頁(yè)面中獲取

6.5 批量注冊標識

6.5.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式:POST
請求路徑：/api/identity/batchCreate
Header:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
params	Array	是	-	批量數據,參考：（單個(gè)請求的參數，保持一致）

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中數據是對應模板版本的數據格式
標識屬性?xún)热莞袷?，即value[i].format暫時(shí)只支持string
接口會(huì )根據templateVersion獲取定義的元數據模板來(lái)限制注冊數據
批量注冊最大支持1000條，超出則給出提示信息
單并發(fā)下，推薦每次批量注冊100-1000個(gè)標識

6.6 更新標識

6.6.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：POST
請求路徑：/api/identity/update
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
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	是	-	標識屬性?xún)热?/td>	-
value[i].data.format	String	是	-	標識屬性?xún)热莞袷剑ìF只支持string）	"string"
value[i].data.vlaue	String	是	255	標識屬性?xún)热葜?/td>	"xxxxxxx"
value[i].data.type	String	是	128	標識屬性類(lèi)型（數據模板的：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 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：POST
請求路徑：/api/identity/batchUpdate
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
params	Array	是	-	批量數據,請參考（單個(gè)請求的格式，保持一致）

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進(jìn)行判斷
}

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 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：POST
請求路徑:/api/identity/del
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
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": []
  }

常見(jiàn)的錯誤見(jiàn)附錄

6.9 批量刪除標識

6.9.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：POST
請求路徑：/api/identity/batchDel
Header:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
params	Array	是	-	批量數據（里面元素和單個(gè)請求格式一樣）

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條，超出則給出提示信息
單并發(fā)下，推薦每次批量刪除100-1000個(gè)標識

# 6. 標識相關(guān)接口

# 6.1 標識列表

# 6.1.1 請求參數

# 6.1.2 請求示例

# 6.1.3 響應參數

# 6.1.4 響應示例

# 6.1.5 異常示例

# 6.2 標識詳情

# 6.2.1 請求參數

# 6.2.2 請求示例

# 6.2.3 響應參數

# 6.2.4 響應示例

# 6.2.5 異常示例

# 6.3 標識查詢(xún)

# 6.3.1 請求參數

# 6.3.2 請求示例

# 6.3.3 響應參數

# 6.3.4 響應示例

# 6.3.5 異常示例

# 6.4 注冊標識

# 6.4.1 請求參數

# 6.4.2 請求示例

# 6.4.3 響應示例

# 6.4.4 異常示

# 6.4.5 注意事項

# 6.5 批量注冊標識

# 6.5.1 請求參數

# 6.5.2 請求示例

# 6.5.3 響應示例

# 6.5.4 異常示例

# 6.5.5 注意事項

# 6.6 更新標識

# 6.6.1 請求參數

# 6.6.2 請求示例

# 6.6.3 響應參數

# 6.6.4 響應示例

# 6.6.5 異常示例

# 6.6.6 注意事項

# 6.7 批量更新標識

# 6.7.1 請求參數

# 6.7.2 請求示例

# 6.7.3 響應示例

# 6.7.4 異常示例

# 6.7.5 注意事項

# 6.8 刪除標識

# 6.8.1 請求參數

# 6.8.2 請求示例

# 6.8.3 響應示例

# 6.8.4 異常示例

# 6.9 批量刪除標識

# 6.9.1 請求參數

# 6.9.2 請求示例

# 6.9.3 響應示例

# 6.9.4 異常示例

# 6.9.5 注意事項

6. 標識相關(guān)接口

6.1 標識列表

6.1.1 請求參數

6.1.2 請求示例

6.1.3 響應參數

6.1.4 響應示例

6.1.5 異常示例

6.2 標識詳情

6.2.1 請求參數

6.2.2 請求示例

6.2.3 響應參數

6.2.4 響應示例

6.2.5 異常示例

6.3 標識查詢(xún)

6.3.1 請求參數

6.3.2 請求示例

6.3.3 響應參數

6.3.4 響應示例

6.3.5 異常示例

6.4 注冊標識

6.4.1 請求參數

6.4.2 請求示例

6.4.3 響應示例

6.4.4 異常示

6.4.5 注意事項

6.5 批量注冊標識

6.5.1 請求參數

6.5.2 請求示例

6.5.3 響應示例

6.5.4 異常示例

6.5.5 注意事項

6.6 更新標識

6.6.1 請求參數

6.6.2 請求示例

6.6.3 響應參數

6.6.4 響應示例

6.6.5 異常示例

6.6.6 注意事項

6.7 批量更新標識

6.7.1 請求參數

6.7.2 請求示例

6.7.3 響應示例

6.7.4 異常示例

6.7.5 注意事項

6.8 刪除標識

6.8.1 請求參數

6.8.2 請求示例

6.8.3 響應示例

6.8.4 異常示例

6.9 批量刪除標識

6.9.1 請求參數

6.9.2 請求示例

6.9.3 響應示例

6.9.4 異常示例

6.9.5 注意事項