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

المعرّف الذي يتوافق مع الجهاز ومفتاح الهوية المرتبط بالجهاز هذا ليس معرّف جهاز، ما يعني أنّه إذا كان لدى المستخدم بيانات اعتماد منفصلة على الجهاز نفسه، سيختلف هذا المعرّف بينهما.

يتم تقديم رقم التعريف هذا في جميع الطلبات، ويمكن استخدامه لربط الطلبات.
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

تمثّل هذه السمة الإصدار الحالي من بيانات الاعتماد التي تم توفيرها.

بيانات الاعتماد

المستند الرقمي على الجهاز الجوّال المستند إلى بيانات الاعتماد، كما هو محدّد بموجب معيار 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.
}
الحقول
حقل الربط presencetype حقل oneof يشير إلى طريقة عرض بيانات الاعتماد. يمكن أن يكون التعليق presencetype إحدى القيم التالية فقط:
encryptedData

object (EncryptedData)

القيمة المشفّرة والبيانات الوصفية للتشفير اللازمة لفك تشفير القيمة
unencryptedValue

string

تمثّل هذه السمة قيمة بيانات الاعتماد المشفّرة باستخدام Base64.