ממשק API פתוח

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

כך אפשר:

• יצירת ספריות לקוח בשפה המועדפת עליכם
• יצירת stubs של שרת
• שימוש בכלים לניהול 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, אפשר לעיין במאמר בנושא אתר עם מתנות.

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

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

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

יצירה של מפתח API

1. עוברים אל הדף 'פרטי כניסה' במסוף GCP.

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

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

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

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

1. למעבר אל ממשקי API שירותים במסוף GCP.
2. ברשימה הנפתחת Select project, בוחרים את של הפרויקט שבו אתם רוצים להפעיל את ממשקי ה-API.
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 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 שלכם.