OpenAPI

OpenAPI REST API के बारे में जानकारी देने के लिए खास जानकारी. इसका इस्तेमाल किया जा रहा है OpenAPI का स्पेसिफ़िकेशन 2.0, Business Messages और Business के लिए, OpenAPI दस्तावेज़ बनाए जा सकते हैं Communications API का इस्तेमाल, पेज के स्ट्रक्चर के बारे में बताने के लिए किया जाता है.

इसकी मदद से, ये काम किए जा सकते हैं:

• अपनी पसंदीदा भाषा में क्लाइंट लाइब्रेरी बनाएं
• सर्वर स्टब बनाएं
• एपीआई मैनेजमेंट टूल इस्तेमाल करना

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 दस्तावेज़ की संरचना के बारे में ज़्यादा जानने के लिए, यहां देखें स्वैगर वेबसाइट.

OpenAPI दस्तावेज़ों को ऐक्सेस करने का तरीका

OpenAPI दस्तावेज़ों को ऐक्सेस करने के लिए, आपके पास Google Cloud से एपीआई पासकोड होना चाहिए Business Messages और Business Communications के साथ प्लैटफ़ॉर्म (GCP) प्रोजेक्ट एपीआई चालू किए गए.

नीचे दिए गए सेक्शन फ़ॉलो करके,

• GCP प्रोजेक्ट बनाना
• API (एपीआई) कुंजी बनाएं
• Business Messages API और Business Communications एपीआई को चालू करें

इन चरणों को पूरा करने के बाद, OpenAPI के दस्तावेज़ ऐक्सेस किए जा सकते हैं.

GCP प्रोजेक्ट बनाना

अगर आपके पास पहले से ही GCP प्रोजेक्ट है, तो एपीआई पासकोड बनाने के लिए इसका इस्तेमाल किया जा सकता है.

नया GCP प्रोजेक्ट बनाने के लिए, यह तरीका अपनाएं:

1. संसाधन मैनेज करें पर जाएं पेज पर क्लिक करें.
2. पेज के सबसे ऊपर मौजूद, संगठन चुनें ड्रॉप-डाउन सूची में जाकर, वह संगठन चुनें जिसके लिए आपको प्रोजेक्ट बनाना है. अगर आप मुफ़्त में आज़माने वाले उपयोगकर्ता हैं, तो यह चरण छोड़ दें.
3. प्रोजेक्ट बनाएं पर क्लिक करें.
4. नया प्रोजेक्ट विंडो में, प्रोजेक्ट का नाम डालें और किसी प्रोजेक्ट को बिलिंग खाता होना चाहिए. प्रोजेक्ट के नाम में सिर्फ़ अक्षर, अंक, और सिंगल हो सकता है कोटेशन, हाइफ़न, स्पेस या विस्मयादिबोधक चिह्नों का इस्तेमाल करें. ये 4 से 30 वर्णों के बीच होने चाहिए.

5. जगह की जानकारी के लिए, पैरंट संगठन या नए प्रोजेक्ट के फ़ोल्डर का नाम डालें.

6. बनाएं पर क्लिक करें.

एपीआई पासकोड बनाना

1. इस पर नेविगेट करें क्रेडेंशियल पेज के लिए ऑप्ट-इन किया जा सकता है.

2. क्रेडेंशियल बनाएं पर क्लिक करें. इसके बाद, एपीआई पासकोड चुनें.

   एपीआई पासकोड बनाया गया डायलॉग बॉक्स, आपकी नई पासकोड दिखाता है. अपनी कुंजी कॉपी करें और उसे सुरक्षित रखें. एपीआई पासकोड के बारे में ज़्यादा जानने के लिए, यहां जाएं: एपीआई पासकोड से जुड़ा दस्तावेज़.

Business Communications API और Business Messages API को चालू करें

अपने GCP प्रोजेक्ट में इन एपीआई को चालू करने के लिए, यह तरीका अपनाएं:

1. एपीआई और GCP कंसोल में सेवाएं पेज पर जाएं.
2. प्रोजेक्ट चुनें ड्रॉप-डाउन सूची में, जिसके लिए आपको एपीआई चालू करने हैं.
3. एपीआई और सेवाएं चालू करें पर क्लिक करें.
4. एपीआई और सेवाएं खोजें फ़ील्ड में, Business Messages डालें.
5. Business Messages API चुनें.
6. चालू करें पर क्लिक करें.
7. एपीआई और सेवाएं चालू करें पर क्लिक करें.
8. एपीआई और सेवाएं खोजें फ़ील्ड में, Business Communications डालें.
9. Business Communications API चुनें.
10. चालू करें पर क्लिक करें.

अब आपकी एपीआई कुंजी के पास Business Messages और Business Communications एपीआई.

OpenAPI दस्तावेज़ों को ऐक्सेस करें

Business Messages API का OpenAPI दस्तावेज़ ऐक्सेस करने के लिए, यह निर्देश चलाएं:

curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

Business Communications API के लिए OpenAPI दस्तावेज़ को ऐक्सेस करने के लिए यह कमांड चलाएं:

curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

API_KEY को अपनी एपीआई पासकोड से बदलें.