OpenAPI REST API का वर्णन करने के लिए एक विशिष्टता है. OpenAPI स्पेसिफ़िकेशन 2.0 का इस्तेमाल करके, Business Messages और Business Communication API के स्ट्रक्चर की जानकारी देने के लिए, आपके पास OpenAPI दस्तावेज़ बनाने की सुविधा है.
इसकी मदद से, ये काम किए जा सकते हैं:
- अपनी पसंदीदा भाषा में क्लाइंट लाइब्रेरी बनाएं
- सर्वर स्टब बनाएं
- एपीआई मैनेजमेंट टूल का इस्तेमाल करना
OpenAPI दस्तावेज़ की बुनियादी संरचना
एक OpenAPI दस्तावेज़ किसी REST API की सतह के बारे में बताता है. यह दस्तावेज़, एपीआई का नाम और जानकारी देता है. साथ ही, एपीआई में मौजूद अलग-अलग एंडपॉइंट (पाथ) और कॉलर की पुष्टि करने के तरीकों की जानकारी भी देता है.
इस बेसिक स्ट्रक्चर का उदाहरण देखने के लिए नीचे क्लिक करें.
JSON
{
"swagger": "2.0",
"host": "businessmessages.googleapis.com",
"info": {
"title": "Business Messages API",
"description": "",
"version": "v1"
},
"paths": {
"/v1/conversations/{conversationsId}/messages": {
"post": {
"description": "Sends a message from an agent to a user.",
"parameters": [
{
"description": "Part of `parent`. Required. The conversation that contains the message. Resolves to \"conversations/{conversationId}\".",
"type": "string",
"in": "path",
"required": true,
"name": "conversationsId"
},
{
"description": "Optional. A flag to send the specified fallback text instead of other message content.",
"name": "forceFallback",
"type": "boolean",
"in": "query"
},
{
"name": "message",
"schema": {
"$ref": "#/definitions/BusinessMessagesMessage"
},
"in": "body",
"description": "Required. The content of a message."
}
],
"tags": [
"businessmessages"
],
"operationId": "CreateMessage",
"responses": {
"default": {
"schema": {
"$ref": "#/definitions/BusinessMessagesMessage"
},
"description": "Successful operation"
}
}
}
}
}
}
किसी OpenAPI दस्तावेज़ की संरचना के बारे में ज़्यादा जानने के लिए, Swagger वेबसाइट देखें.
OpenAPI दस्तावेज़ों को कैसे ऐक्सेस करें
OpenAPI दस्तावेज़ों तक पहुंचने के लिए, आपके पास Google क्लाउड प्लैटफ़ॉर्म (GCP) प्रोजेक्ट से एपीआई कुंजी होनी चाहिए. इसमें Business Messages और Business Communications एपीआई चालू होने चाहिए.
नीचे दिए गए सेक्शन फ़ॉलो करके
- GCP प्रोजेक्ट बनाना
- API (एपीआई) कुंजी बनाएं
- Business Messages API और Business Communications एपीआई चालू करें
इन चरणों को पूरा करके, आप OpenAPI दस्तावेज़ों को ऐक्सेस कर सकते हैं.
GCP प्रोजेक्ट बनाना
अगर आपके पास पहले से ही GCP प्रोजेक्ट है, तो उसका इस्तेमाल एपीआई कुंजी बनाने के लिए किया जा सकता है.
नया GCP प्रोजेक्ट बनाने के लिए, ये काम करें:
- GCP कंसोल में संसाधनों को मैनेज करें पेज पर जाएं.
- पेज के सबसे ऊपर मौजूद संगठन चुनें ड्रॉप-डाउन सूची में, वह संगठन चुनें जिसके लिए आपको प्रोजेक्ट बनाना है. अगर आप मुफ़्त में आज़माने वाले उपयोगकर्ता हैं, तो यह चरण छोड़ दें.
- प्रोजेक्ट बनाएं पर क्लिक करें.
- नया प्रोजेक्ट विंडो में, प्रोजेक्ट का नाम डालें और ज़रूरत के मुताबिक, कोई बिलिंग खाता चुनें. प्रोजेक्ट के नाम में सिर्फ़ अक्षर, संख्याएं, सिंगल कोट, हाइफ़न, स्पेस या विस्मयादिबोधक चिह्न हो सकते हैं. साथ ही, इनमें 3 से 30 वर्ण हो सकते हैं.
जगह की जानकारी वाले नए प्रोजेक्ट के लिए, पैरंट संगठन या फ़ोल्डर की जानकारी डालें.
बनाएं पर क्लिक करें.
एपीआई कुंजी बनाना
GCP कंसोल में क्रेडेंशियल पेज पर जाएं.
क्रेडेंशियल बनाएं पर क्लिक करके एपीआई कुंजी चुनें.
एपीआई कुंजी बनाई गई डायलॉग बॉक्स आपकी नई बनाई गई कुंजी दिखाता है. अपनी कुंजी कॉपी करें और उसे सुरक्षित रखें. एपीआई कुंजियों के बारे में ज़्यादा जानने के लिए, एपीआई कुंजी दस्तावेज़ देखें.
Business Communications एपीआई और Business Messages API चालू करना
इन एपीआई को अपने GCP प्रोजेक्ट में चालू करने के लिए, ये करें:
- GCP कंसोल में, एपीआई और सेवाएं पेज पर जाएं.
- प्रोजेक्ट चुनें ड्रॉप-डाउन सूची में, वह प्रोजेक्ट चुनें जिसके लिए आपको एपीआई चालू करने हैं.
- एपीआई और सेवाएं चालू करें पर क्लिक करें.
- एपीआई और सेवाएं खोजें फ़ील्ड में, कारोबार के मैसेज डालें.
- Business Messages एपीआई चुनें.
- चालू करें पर क्लिक करें.
- एपीआई और सेवाएं चालू करें पर क्लिक करें.
- एपीआई और सेवाएं खोजें फ़ील्ड में, Business Communications डालें.
- Business Communications एपीआई चुनें.
- चालू करें पर क्लिक करें.
अब आपकी एपीआई कुंजी से, Business Messages और Business Communications एपीआई के लिए, OpenAPI दस्तावेज़ ऐक्सेस करने की अनुमति मिल गई है.
OpenAPI दस्तावेज़ ऐक्सेस करें
Business Messages API के लिए, ओपन एपीआई का दस्तावेज़ ऐक्सेस करने के लिए यह निर्देश दें:
curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"
Business Communications एपीआई के लिए OpenAPI दस्तावेज़ ऐक्सेस करने के लिए यह निर्देश चलाएं:
curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"
API_KEY को अपनी एपीआई कुंजी से बदलें.