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 ดูรูปแบบ mDL mDoc ได้ที่นี่

การแสดง 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