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 از قبل وجود داشته باشد، به جای ایجاد یک credential جدید، این متد باید credential موجود را برگرداند.

مثال: شناسه کاربری

proofingId

string

الزامی. یک شناسه‌ی مبهم که نشان‌دهنده‌ی اثبات با مجموعه‌ای خاص از شواهد، برای یک دستگاه خاص است.

اثبات باید در حالت تأیید شده (Approved) باشد. در غیر این صورت، شناسه نامعتبر 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 . الزامی. یکی از مواردی که نحوه ارائه اعتبارنامه را نشان می‌دهد. presencetype فقط می‌تواند یکی از موارد زیر باشد:
encryptedData

object ( EncryptedData )

مقدار رمزگذاری شده و فراداده رمزگذاری لازم برای رمزگشایی مقدار.

unencryptedValue

string

مقدار کدگذاری شده‌ی base64 مربوط به اعتبارنامه.