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 ได้ที่เว็บไซต์ Swกว้าง

วิธีเข้าถึงเอกสาร OpenAPI

หากต้องการเข้าถึงเอกสาร OpenAPI คุณต้องมีคีย์ API จากโปรเจ็กต์ Google Cloud Platform (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 ของคุณ