OpenAPI

OpenAPI هي واجهة مواصفات وصف واجهات برمجة تطبيقات REST. استخدام الإصدار 2.0 من مواصفات OpenAPI يمكنك إنشاء مستندات OpenAPI الخاصة بميزة "الرسائل التجارية" و"الرسائل التجارية" واجهات برمجة التطبيقات للاتصالات لوصف بنيتها.

ويسمح لك هذا الإجراء بما يلي:

• إنشاء مكتبات العملاء بلغتك المفضّلة
• إنشاء رموز بديلة للخادم
• استخدام أدوات إدارة واجهة برمجة التطبيقات

البنية الأساسية لمستند OpenAPI

يصف مستند OpenAPI سطح واجهة برمجة تطبيقات REST. يحدد المستند اسم ووصف واجهة برمجة التطبيقات، ونقاط النهاية الفردية (المسارات) في واجهة برمجة التطبيقات وكيفية مصادقة المتصلين والمزيد.

انقر أدناه لعرض مثال لهذه البنية الأساسية.

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، يجب أن يكون لديك مفتاح واجهة برمجة تطبيقات من Google Cloud. مشروع المنصة (GCP) مع ميزة "الرسائل التجارية" و"اتصالات النشاط التجاري" تم تفعيل واجهات برمجة التطبيقات.

اتّبِع الأقسام التالية من أجل:

• إنشاء مشروع Google Cloud Platform
• إنشاء مفتاح واجهة برمجة التطبيقات
• تفعيل Business Message API وBusiness Communications API

بعد إكمال هذه الخطوات، يمكنك الوصول إلى مستندات OpenAPI.

إنشاء مشروع Google Cloud Platform

إذا كان لديك مشروع Google Cloud Platform من قبل، يمكنك استخدامه من أجل إنشاء مفتاح واجهة برمجة تطبيقات.

لإنشاء مشروع Google Cloud Platform جديد، اتّبِع الخطوات التالية:

1. انتقِل إلى صفحة إدارة الموارد. صفحة في وحدة تحكُّم Google Cloud Platform.
2. في القائمة المنسدلة اختيار مؤسسة في أعلى الصفحة، حدد المؤسسة التي تريد إنشاء المشروع لها. إذا كنت تستخدم الفترة التجريبية المجانية، يمكنك تخطّي هذه الخطوة.
3. انقر على إنشاء مشروع.
4. في نافذة مشروع جديد، أدخِل اسم مشروع واختَر حساب الفوترة حسب الاقتضاء. لا يمكن أن يحتوي اسم المشروع إلا على أحرف أو أرقام أو فردية علامات الاقتباس أو الواصلات أو المسافات أو علامات التعجب، ويجب أن يتراوح طولها بين 4 أحرف و30 حرفًا.

5. في حقل الموقع الجغرافي، أدخِل المؤسسة أو المجلد الرئيسي للمشروع الجديد.

6. انقر على إنشاء.

إنشاء مفتاح واجهة برمجة التطبيقات

1. الانتقال إلى صفحة بيانات الاعتماد في وحدة تحكُّم Google Cloud Platform.

2. انقر على إنشاء بيانات اعتماد، ثم اختَر مفتاح واجهة برمجة التطبيقات.

   يعرض مربّع الحوار تم إنشاء مفتاح واجهة برمجة التطبيقات المفتاح الذي تم إنشاؤه حديثًا. انسخ مفتاحك وحافِظ على أمانه. لمزيد من المعلومات حول مفاتيح واجهة برمجة التطبيقات، يُرجى الاطّلاع على المستندات حول مفتاح واجهة برمجة التطبيقات:

تفعيل Business Communications API وBusiness Message API

لتفعيل واجهات برمجة التطبيقات هذه في مشروع Google Cloud Platform، عليك إجراء ما يلي:

1. انتقِل إلى واجهات برمجة التطبيقات الخدمات في وحدة تحكُّم Google Cloud Platform.
2. في القائمة المنسدلة اختيار مشروع، اختَر المشروع الذي تريد تفعيل واجهات برمجة التطبيقات له.
3. انقر على تفعيل واجهات برمجة التطبيقات والخدمات.
4. في الحقل البحث عن واجهات برمجة التطبيقات والخدمات، أدخِل الرسائل التجارية.
5. اختَر واجهة برمجة تطبيقات ميزة "الرسائل التجارية".
6. انقر على تفعيل.
7. انقر على تفعيل واجهات برمجة التطبيقات والخدمات.
8. في الحقل البحث عن واجهات برمجة التطبيقات والخدمات، أدخِل Business Communications.
9. اختَر Business Communications API.
10. انقر على تفعيل.

أصبح لدى مفتاح واجهة برمجة التطبيقات الآن أذونات للوصول إلى مستندات OpenAPI واجهات برمجة تطبيقات "الرسائل التجارية" و"مراسلات النشاط التجاري"

الوصول إلى مستندات OpenAPI

شغِّل الأمر التالي للوصول إلى مستند OpenAPI الخاص بواجهة برمجة تطبيقات "الرسائل التجارية":

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 بمفتاح واجهة برمجة التطبيقات الخاص بك.