Method: vdc.provisionCredential

क्रेडेंशियल उपलब्ध कराने के लिए एक एंडपॉइंट.

एचटीटीपी अनुरोध

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 पहले से मौजूद है, तो नया क्रेडेंशियल बनाने के बजाय, इस तरीके से मौजूदा क्रेडेंशियल वापस मिलना चाहिए.

उदाहरण: यूयूआईडी
proofingId

string

यह एक ओपेक आइडेंटिफ़ायर है. यह किसी डिवाइस के लिए, सबूतों के किसी बंडल के साथ पुष्टि करने की प्रोसेस को दिखाता है.

प्रूफ़िंग की स्थिति 'स्वीकार किया गया' होनी चाहिए. अगर ऐसा नहीं है, तो अमान्य आइडेंटिफ़ायर वाली ErrorResponse को वापस भेजना चाहिए.
deviceEncryptionKey

object (DeviceEncryptionKey)

यह एक ऐसा ऑब्जेक्ट होता है जिसमें डिवाइस की कुछ समय के लिए इस्तेमाल की जाने वाली एन्क्रिप्शन कुंजी और उससे जुड़ा मेटाडेटा होता है. इस कुकी का इस्तेमाल, वैल्यू को वापस डिवाइस पर एन्क्रिप्ट (सुरक्षित) करने के लिए किया जाता है. ऐसा हो सकता है कि यह ऑब्जेक्ट, ऑनबोर्डिंग के दौरान सैंडबॉक्स एनवायरमेंट में उपलब्ध न हो. इसका मतलब है कि जारी करने वाले को सादा टेक्स्ट वाला डेटा वापस भेजना चाहिए. इसे हमेशा प्रोडक्शन एनवायरमेंट में सेट किया जाना चाहिए.

जवाब का मुख्य भाग

जवाब में, उपलब्ध कराई गई क्रेडेंशियल शामिल होती है.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
फ़ील्ड
responseMetadata

object (ResponseMetadata)

जवाब के बारे में मेटाडेटा. यह सभी जवाबों में ज़रूरी होता है.
credential

object (Credential)

उपलब्ध कराया गया क्रेडेंशियल.
credentialVersionId

string

सर्टिफ़िकेट का मौजूदा वर्शन, जिसे मैनेज किया गया है.

क्रेडेंशियल

एमडॉक पर आधारित क्रेडेंशियल, जैसा कि क्रेडेंशियल टाइप के लिए आईएसओ के संबंधित स्टैंडर्ड में बताया गया है.

उदाहरण के लिए, मोबाइल पर मौजूद ड्राइविंग लाइसेंस के लिए, यह 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. यह एक ऐसा विकल्प है जिससे पता चलता है कि क्रेडेंशियल कैसे दिखाया जा रहा है. presencetype इनमें से सिर्फ़ एक हो सकता है:
encryptedData

object (EncryptedData)

एन्क्रिप्ट की गई वैल्यू और वैल्यू को डिक्रिप्ट करने के लिए ज़रूरी एन्क्रिप्शन मेटाडेटा.
unencryptedValue

string

क्रेडेंशियल की base64 कोड में बदली गई वैल्यू.