1. 接口描述
接口请求域名: tdid.tencentcloudapi.com 。
使用导入的公钥文件注册DID标识
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTDidByPubKey。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DAPId | 否 | Integer | DID应用id 示例值:1 |
PublicKey | 否 | String | pem格式的认证公钥 示例值:-----BEGIN PUBLIC KEY-----\r\nMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEdPxYz6u53NB5WqgESSaRYwDSPeBUuyke8CTlyWn7/BYpbRKQTzt3b3O+QYeMSJULvclDsj+pFCZPh9lLrBNU6w==\r\n-----END PUBLIC KEY----- |
CustomAttribute | 否 | String | 自定义DID初始化属性json字符串 示例值:{"name":"李四"} |
IgnoreExisted | 否 | Integer | 0:did存在返回错误,1:did存在返回该did,默认:0 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Did | String | did标识 示例值:did:tdid:w1:0x4b5edc27dd8a20ebaae6d427f3142b24fbf687ff |
Transaction | ChainTransaction | 链上交易信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导入公钥注册DID标识
上传用户本地公钥文件创建DID标识
输入示例
POST / HTTP/1.1
Host: tdid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTDidByPubKey
<公共请求参数>
{
"DAPId": 1,
"PublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAEaI9IwGTO3SL6tamGNdyFi+zg8W7W\n53dKNBC3xuRXdlbor0gTIlYSgKIyClY6KUrizmW6gMfKcrzBojml5j4JJg==\n-----END PUBLIC KEY-----"
}
输出示例
{
"Response": {
"RequestId": "fac6ef5a-7637-4a75-a2d3-0f7d87b5b8b5",
"Did": "did:tdid:w1:0xdab41eb32082044366f1b5712504d0b623b095c1",
"Transaction": {
"TransactionHash": "1747ae57db16f1d6cac4b711742904f87030f3eee8704439aa203a8278d219c3"
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.InvalidAuth | 用户接口鉴权失败 |
FailedOperation.OperationException | 操作失败。 |
InternalError | 内部错误。 |
InternalError.ServerException | 服务器异常。 |
InternalError.ServiceDisabled | 服务已停止,请您检查当前是否有计费套餐包 |
InternalError.ServiceError | 服务错误,请稍后重试,或联系客服 |
InternalError.ServicePanic | 服务异常。 |
InternalError.UnknownError | 服务错误,请稍后重试,或联系客服 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.IllegalValue | 请求参数格式错误,请按照格式要求重新填写 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |