Method: vdc.provisionCredential

ปลายทางสำหรับจัดสรรข้อมูลเข้าสู่ระบบ

คำขอ HTTP

POST https://example.issuer.com/api/v1/vdc/provisionCredential

เนื้อหาคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
ช่อง
requestMetadata

object (RequestMetadata)

ต้องระบุ ข้อมูลเมตาเกี่ยวกับคำขอ ซึ่งจำเป็นในคำขอทั้งหมด
deviceReferenceId

string

ต้องระบุ รหัสที่ตรงกับอุปกรณ์และคีย์ข้อมูลประจำตัวที่เชื่อมโยงกับอุปกรณ์ รหัสนี้ไม่ใช่รหัสอุปกรณ์ ซึ่งหมายความว่าหากผู้ใช้มีข้อมูลเข้าสู่ระบบ 2 รายการแยกกันในอุปกรณ์เครื่องเดียวกัน รหัสนี้จะแตกต่างกัน

ระบบจะระบุรหัสนี้ในคำขอทั้งหมด และคุณสามารถใช้รหัสนี้เพื่อเชื่อมโยงคำขอต่างๆ ได้
credentialId

string

ต้องระบุ ตัวระบุแบบทึบแสงที่แสดงถึงข้อมูลเข้าสู่ระบบที่จัดสรรให้กับอุปกรณ์

หาก credentialId มีอยู่แล้ว วิธีนี้ควรแสดงผลข้อมูลเข้าสู่ระบบที่มีอยู่แทนที่จะสร้างข้อมูลเข้าสู่ระบบใหม่

เช่น UUID
proofingId

string

ต้องระบุ ตัวระบุแบบทึบแสงที่แสดงถึงการยืนยันตัวตนด้วยชุดหลักฐานที่เฉพาะเจาะจงสำหรับอุปกรณ์ที่เฉพาะเจาะจง

การยืนยันตัวตนต้องอยู่ในสถานะ "ได้รับอนุมัติ" หากไม่อยู่ในสถานะดังกล่าว ระบบควรแสดงผล ErrorResponse ที่มีตัวระบุที่ไม่ถูกต้อง
deviceEncryptionKey

object (DeviceEncryptionKey)

ต้องระบุ ออบเจ็กต์ที่มีคีย์การเข้ารหัสแบบชั่วคราวของอุปกรณ์และข้อมูลเมตาที่เกี่ยวข้อง คีย์นี้ใช้สำหรับการเข้ารหัสค่ากลับไปยังอุปกรณ์ ระบบอาจไม่ระบุออบเจ็กต์นี้ในสภาพแวดล้อมแซนด์บ็อกซ์ระหว่างการเริ่มต้นใช้งาน ซึ่งบ่งบอกว่าผู้ออกควรแสดงผลข้อมูลข้อความธรรมดา ควรตั้งค่านี้ในสภาพแวดล้อมฮาร์ดแวร์และซอฟต์แวร์เสมอ

เนื้อหาการตอบกลับ

การตอบกลับที่มีข้อมูลเข้าสู่ระบบที่จัดสรร

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
ช่อง
responseMetadata

object (ResponseMetadata)

ต้องระบุ ข้อมูลเมตาเกี่ยวกับการตอบกลับ ซึ่งจำเป็นในการตอบกลับทั้งหมด
credential

object (Credential)

ต้องระบุ ข้อมูลเข้าสู่ระบบที่จัดสรร
credentialVersionId

string

ต้องระบุ เวอร์ชันปัจจุบันของข้อมูลเข้าสู่ระบบที่จัดสรร

การรับรอง

ข้อมูลเข้าสู่ระบบที่อิงตาม mdoc ตามที่กำหนดโดยมาตรฐาน ISO ที่เกี่ยวข้องสำหรับประเภทข้อมูลเข้าสู่ระบบ

เช่น สำหรับใบขับขี่บนอุปกรณ์เคลื่อนที่ ข้อมูลนี้จะเป็น ISO/IEC 18013-5 ดูรูปแบบ mDoc ของ mDL ได้ที่ นี่

การแสดง JSON 
{

  // Union field presencetype can be only one of the following:
  "encryptedData": {
    object (EncryptedData)
  },
  "unencryptedValue": string
  // End of list of possible types for union field presencetype.
}
ช่อง
ฟิลด์ Union presencetype ต้องระบุ oneof ที่ระบุวิธีนำเสนอข้อมูลเข้าสู่ระบบ presencetype จะมีค่าได้เพียงค่าใดค่าหนึ่งต่อไปนี้
encryptedData

object (EncryptedData)

ค่าที่เข้ารหัสและข้อมูลเมตาการเข้ารหัสที่จำเป็นต่อการถอดรหัสค่า
unencryptedValue

string

ค่าข้อมูลเข้าสู่ระบบที่เข้ารหัสแบบ Base64