更新时间:2023-09-15 GMT+08:00
分享

组织用户加密消息

功能介绍

组织用户加密消息接口,调用接口需要配置组织用户的TLS证书。组织用户的TLS证书可以从BCS服务实例概览页面下载配置文件获得。

URI

POST /v1/e2ee/org/encrypt

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

target_org_ids

Array of strings

可以解密消息的组织ID

最小长度:14

最大长度:24

数组长度:1 - 99

message

String

组织的用户输入需要加密的信息

最小长度:1

最大长度:65535

up_to_chain

Boolean

是否加密后发送到链上,默认为true,加密后直接上链

枚举值:

  • true

  • false

update_group_key

Boolean

是否更新组秘钥

枚举值:

  • true

  • false

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

transaction_id

String

消息加密后对应的交易ID,用于查询解密后明文

最小长度:64

最大长度:64

data_to_chain

Array of strings

非代为上链场景下,加密后的密文,需要在SDK侧完成上链

状态码: 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:15

error_msg

String

错误信息

最小长度:16

最大长度:200

请求示例

加密一条消息,允许组织ID为“organization2-kdkvs88qk”的组织解密该消息,由E2EE服务代为上链,不更新组秘钥。url中变量{domain}由服务IP地址和端口号组成。从BCS实例的插件管理页面可以获取服务ip地址,插件详情页面可以获取组织的端口号。

https://{{domain}}/v1/e2ee/org/encrypt

{
  "message" : "hello, this test message",
  "target_org_ids" : [ "organization2-kdkvs88qk" ],
  "up_to_chain" : true,
  "update_group_key" : false
}

响应示例

状态码: 200

成功响应

{
  "transaction_id" : "1feda96bbf878fe856f9801aed3de107c0dc832996ac6f99d8821350dc6c37c5",
  "data_to_chain" : null
}

状态码

状态码

描述

200

成功响应

400

错误响应

分享:

    相关文档

    相关产品