用于配置凭据的端点。
HTTP 请求
POST https://example.issuer.com/api/v1/vdc/provisionCredential
请求正文
请求正文中包含结构如下的数据:
| JSON 表示法 |
|---|
{ "requestMetadata": { object ( |
| 字段 | |
|---|---|
requestMetadata |
有关请求的元数据,所有请求中都需要提供。 |
deviceReferenceId |
与设备对应的 ID 以及与设备关联的身份密钥。此 ID 不是设备 ID,也就是说,如果用户在同一设备上拥有两个不同的凭据,则此 ID 会有所不同。 此 ID 会在所有请求中提供,可用于关联请求。 |
credentialId |
表示已向设备配置的特定凭据的不透明标识符。 如果 credentialId 已存在,此方法应返回现有凭据,而不是创建新凭据。 示例:UUID |
proofingId |
一个不透明的标识符,用于表示特定设备的特定证据包的验证。 校样必须处于“已批准”状态。否则,应返回无效的标识符 ErrorResponse。 |
deviceEncryptionKey |
一个包含设备的临时加密密钥和关联元数据的对象。此密钥用于将值加密回设备。此对象可能不会在初始配置期间于沙盒环境中提供,表明发卡机构应返回纯文本数据。此值应始终在生产环境中设置。 |
响应正文
包含已配置凭据的响应。
如果成功,响应正文将包含结构如下的数据:
| JSON 表示法 |
|---|
{ "responseMetadata": { object ( |
| 字段 | |
|---|---|
responseMetadata |
有关响应的元数据,所有响应中都需要包含此元数据。 |
credential |
已预配的凭据。 |
credentialVersionId |
已配置的凭据的当前版本。 |
凭据
基于 mdoc 的凭据,由相关 ISO 标准针对凭据类型定义。
例如,对于移动驾驶执照,此标准为 ISO/IEC 18013-5。如需了解 mDL mDoc 格式,请参阅此处。
| JSON 表示法 |
|---|
{ // Union field |
| 字段 | |
|---|---|
联合字段 presencetype。一个 oneof,用于指示凭据的呈现方式。presencetype 只能是下列其中一项: |
|
encryptedData |
加密值以及解密该值所需的加密元数据。 |
unencryptedValue |
凭据的 base64 编码值。 |