ממשק API של OpenAPI

OpenAPI הוא מפרט לתיאורים של ממשקי API ל-REST. בעזרת מפרט API של OpenAPI 2.0 אפשר ליצור מסמכי OpenAPI לממשקי Business Messages ול-Business Communication API כדי לתאר את המבנה שלהם.

כך תוכלו:

• יצירת ספריות לקוח בשפה המועדפת עליך
• יצירת מצייני שרת
• שימוש בכלים לניהול API

המבנה הבסיסי של מסמך OpenAPI

מסמך OpenAPI מתאר את פני השטח של API ל-REST. במסמך מוגדרים השם והתיאור של ה-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, היכנסו לאתר של Swagger.

איך ניגשים למסמכי 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. נכנסים לדף Manage resources במסוף ה-GCP.
2. ברשימה הנפתחת בחירת ארגון בחלק העליון של הדף, בוחרים את הארגון שעבורו רוצים ליצור את הפרויקט. אם יש לך תקופת ניסיון בחינם, אפשר לדלג על השלב הזה.
3. לוחצים על Create Project.
4. בחלון New Project (פרויקט חדש), מזינים את שם הפרויקט ובוחרים את החשבון לחיוב הרלוונטי. שם הפרויקט יכול לכלול רק אותיות, ספרות, מירכאות, מקפים, רווחים או סימני קריאה והוא חייב להיות בין 4 ל-30 תווים.

5. בקטע מיקום, מזינים את שם הארגון או התיקייה של הפרויקט החדש.

6. לוחצים על יצירה.

יצירת מפתח API

1. נכנסים לדף Credentials במסוף GCP.

2. לוחצים על Create credentials ואז על API key.

   תיבת הדו-שיח API key created מציגה את המפתח החדש שיצרתם. צריך להעתיק את המפתח ולוודא שהוא מאובטח. מידע נוסף על מפתחות API זמין במאמר תיעוד בנושא מפתחות API.

הפעלת ה-Business Communications API ו-Business Messages API

כדי להפעיל את ממשקי ה-API האלה בפרויקט GCP, צריך לבצע את הפעולות הבאות:

1. נכנסים לדף APIs & amp; Services במסוף GCP.
2. ברשימה הנפתחת Select project, בוחרים את הפרויקט שעבורו רוצים להפעיל את APIs.
3. לוחצים על Enable APIs and services.
4. בשדה חיפוש ממשקי API ושירותים, מזינים Business Messages.
5. בוחרים באפשרות Business Messages API.
6. לוחצים על Enable.
7. לוחצים על Enable APIs and services.
8. בשדה חיפוש ממשקי API ושירותים, מזינים תקשורת עסקית.
9. בוחרים באפשרות Business Communications API.
10. לוחצים על Enable.

עכשיו למפתח ה-API יש הרשאות גישה למסמכי OpenAPI עבור Business Messages ו-Business Communications APIs.

גישה למסמכי OpenAPI

כדי להריץ את מסמך OpenAPI API של Business Messages, מריצים את הפקודה הבאה:

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

מריצים את הפקודה הבאה כדי לפתוח את מסמך OpenAPI for Business Communications API:

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

מחליפים את הערך API_KEY במפתח ה-API שלכם.