有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

接口请求域名: tdid.tencentcloudapi.com 。

获取DID标识的文档

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetTDidDocument。
Version String 公共参数,本接口取值:2021-05-19。
Region String 公共参数,详见产品支持的 地域列表
Did String DID标识
示例值:did:tdid:w1:0xa75368ab6ab9cb6d01e81d22155279ee4eca3f4d
DAPId Integer DID应用ID
示例值:1

3. 输出参数

参数名称 类型 描述
Document String DID文档内容
示例值:
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取DID标识的文档

输入示例

POST / HTTP/1.1
Host: tdid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTDidDocument
<公共请求参数>

{
    "DAPId": 1,
    "Did": "did:tdid:w1:0x05cdde231b90dbcb1e0a9e7a616bf17c7168c2ac"
}

输出示例

{
    "Response": {
        "Document": "{\n  \"@context\" : \"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\",\n  \"symbol\" : \"BAYC\",\n  \"creator\" : \"did:tdid:w1:0x1a8ca5daffe98e48483fa58d7b352998c34705ca\",\n  \"controller\" : \"did:tdid:w1:0x6206a748ad9d3bc35fdbe6ac5248791ae9bb8d45\",\n  \"created\" : \"2022-08-08T03:23:40+0000\",\n  \"contract\" : \"BAYC1659929019\",\n  \"totalCount\" : 1,\n  \"deactivated\" : false,\n  \"versionId\" : 1,\n  \"baseUrl\" : \"https://ipfs.io/ipfs/QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq\",\n  \"service\" : [ ],\n  \"portalUrl\" : \"\",\n  \"name\" : \"BoredApeYachtClub\",\n  \"id\" : \"did:tdid:cm775g1:0x6206a748ad9d3bc35fdbe6ac5248791ae9bb8d45\",\n  \"verificationMethod\" : [ {\n    \"controller\" : \"did:tdid:cm775g1:0x6206a748ad9d3bc35fdbe6ac5248791ae9bb8d45\",\n    \"id\" : \"did:tdid:cm775g1:0x6206a748ad9d3bc35fdbe6ac5248791ae9bb8d45#keys-0\",\n    \"publicKey\" : \"-----BEGIN PUBLIC KEY-----\\r\\nMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAE8AxGIIZS5gNWEBmoAOsHxPd/8D2DrKqMuiWG2cVvYDt6H0CjWixP/RYeTXyRDjuLXd2tINL5VWKzm1EOlhQE+w==\\r\\n-----END PUBLIC KEY-----\",\n    \"type\" : \"Sm2p256v1\",\n    \"revoked\" : false\n  } ],\n  \"updated\" : \"2022-08-08T03:23:40+0000\",\n  \"desc\" : \"Bored Ape Yacht Club\",\n  \"authentication\" : [ \"#keys-0\" ]\n}",
        "RequestId": "fac6ef5a-7637-4a75-a2d3-0f7d87b5b8b5"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
Cam.InvalidAuth CAM鉴权失败
DataBase.FailedOperation 数据库操作失败,请重新操作
DidFailedOperation.DidNotExisted DID标识不存在:<%ExtMsg%>
DidFailedOperation.DidSvcNotExisted 用户尚未创建DID服务,请确认后重新操作
DidFailedOperation.GetDidDocFiled 获取DID文档失败,请重新操作
DidSdk.UnknownError DID服务请求错误,请稍后重试或联系客服
FailedOperation.InvalidAuth 用户接口鉴权失败
FailedOperation.OperationException 操作失败。
FailedOperation.PermissionDenied 用户无接口访问权限
HttpInvoker.NewQuestError HTTP请求创建失败,请稍后重试,或联系客服
HttpInvoker.SendQuestError HTTP请求发送失败,请稍后重试,或联系客服
InternalError.ApiUnknownError API服务出错
InternalError.ServiceError 服务错误,请稍后重试,或联系客服
InternalError.UnknownError 服务错误,请稍后重试,或联系客服
InvalidParameterValue.IllegalDateTime 无效的时间格式,请确认后重新操作
InvalidParameterValue.IllegalValue 请求参数格式错误,请按照格式要求重新填写
InvalidParameterValue.ResourceNotExisted 用户请求资源未存在:<%ExtMsg%>