OpenAPI

OpenAPI คือ ข้อกำหนดในการอธิบาย REST API การใช้ ข้อกำหนด OpenAPI 2.0 คุณสามารถสร้างเอกสาร OpenAPI สำหรับ Business Messages และ Business Communications API เพื่ออธิบายโครงสร้าง

ซึ่งจะช่วยให้คุณทําสิ่งต่อไปนี้ได้

• สร้างไลบรารีของไคลเอ็นต์ในภาษาที่คุณต้องการ
• สร้างต้นขั้วเซิร์ฟเวอร์
• ใช้เครื่องมือการจัดการ API

โครงสร้างพื้นฐานของเอกสาร OpenAPI

เอกสาร OpenAPI อธิบายลักษณะหน้าตาของ REST API เอกสารจะกำหนด ชื่อและคำอธิบายของ API รวมถึงปลายทาง (เส้นทาง) แต่ละรายการใน 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 คุณต้องมีคีย์ API จาก Google Cloud โปรเจ็กต์แพลตฟอร์ม (GCP) ที่มี Business Messages และ Business Communications เปิดใช้ API แล้ว

ทำตามส่วนด้านล่างเพื่อ

• สร้างโปรเจ็กต์ GCP
• สร้างคีย์ API
• เปิดใช้ Business Messages API และ Business Communications API

เมื่อทำตามขั้นตอนเหล่านี้แล้ว คุณจะสามารถเข้าถึงเอกสาร OpenAPI ได้

สร้างโปรเจ็กต์ GCP

หากมีโปรเจ็กต์ GCP อยู่แล้ว คุณจะใช้โปรเจ็กต์ดังกล่าวเพื่อสร้างคีย์ API ได้

หากต้องการสร้างโปรเจ็กต์ GCP ใหม่ ให้ทำดังนี้

1. ไปที่จัดการทรัพยากร ในคอนโซล GCP
2. ในรายการแบบเลื่อนลงเลือกองค์กรที่ด้านบนของหน้า เลือกองค์กรที่คุณต้องการสร้างโปรเจ็กต์ให้ หากเป็นผู้ใช้ช่วงทดลองใช้ฟรี ให้ข้ามขั้นตอนนี้
3. คลิกสร้างโปรเจ็กต์
4. ในหน้าต่างโปรเจ็กต์ใหม่ ให้ป้อนชื่อโปรเจ็กต์ แล้วเลือก บัญชีสำหรับการเรียกเก็บเงินตามที่เกี่ยวข้อง ชื่อโปรเจ็กต์มีได้เฉพาะตัวอักษร ตัวเลข บรรทัดเดียว เครื่องหมายคำพูด ขีดกลาง เว้นวรรค หรือเครื่องหมายอัศเจรีย์ และต้องมีอักขระระหว่าง 4 ถึง 30 ตัว

5. ในส่วนตำแหน่ง ให้ป้อนองค์กรหรือโฟลเดอร์ระดับบนสุดสำหรับโปรเจ็กต์ใหม่

6. คลิกสร้าง

สร้างคีย์ API

1. นำทางไปที่ หน้าข้อมูลเข้าสู่ระบบ ในคอนโซล GCP

2. คลิกสร้างข้อมูลเข้าสู่ระบบ แล้วเลือกคีย์ API

   กล่องโต้ตอบคีย์ API ที่สร้างจะแสดงคีย์ที่สร้างขึ้นใหม่ คัดลอกคีย์และเก็บคีย์ให้ปลอดภัย ดูข้อมูลเพิ่มเติมเกี่ยวกับคีย์ API ได้ที่ เอกสารประกอบเกี่ยวกับคีย์ API

เปิดใช้ Business Communications API และ Business Messages API

หากต้องการเปิดใช้ API เหล่านี้ในโปรเจ็กต์ GCP ให้ทำดังนี้

1. ไปที่ API และ บริการในคอนโซล GCP
2. ในรายการแบบเลื่อนลงเลือกโปรเจ็กต์ ให้เลือก โปรเจ็กต์ที่ต้องการเปิดใช้ API
3. คลิกเปิดใช้ API และบริการ
4. ในช่องค้นหา API และบริการ ให้ป้อน Business Messages
5. เลือก Business Messages API
6. คลิกเปิดใช้
7. คลิกเปิดใช้ API และบริการ
8. ในช่องค้นหา API และบริการ ให้ป้อนการสื่อสารทางธุรกิจ
9. เลือก Business Communications API
10. คลิกเปิดใช้

ตอนนี้คีย์ API ของคุณมีสิทธิ์เข้าถึงเอกสาร OpenAPI สำหรับ Business Messages และ Business Communications API

เข้าถึงเอกสาร OpenAPI

เรียกใช้คำสั่งนี้เพื่อเข้าถึงเอกสาร OpenAPI สำหรับ Business Messages API

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

เรียกใช้คำสั่งนี้เพื่อเข้าถึงเอกสาร OpenAPI สำหรับ Business Communications API

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

แทนที่ API_KEY ด้วยคีย์ API