واجهة برمجة التطبيقات

تُعد OpenAPI أحد المواصفات المخصصة لوصف واجهات برمجة تطبيقات REST. باستخدام مواصفات OpenAPI 2.0، يمكنك إنشاء مستندات OpenAPI لواجهات برمجة تطبيقات Business Messages واتصالات Business لوصف بنيتها.

ويتيح لك ذلك إجراء ما يلي:

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

البنية الأساسية لمستند 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، يُرجى الاطّلاع على موقع Swagg الإلكتروني.

كيفية الدخول إلى مستندات OpenAPI

للوصول إلى مستندات OpenAPI، يجب أن يتوفر لديك مفتاح واجهة برمجة تطبيقات من مشروع Google Cloud Platform (GCP) مع تفعيل واجهات برمجة تطبيقات الرسائل التجارية والاتصالات التجارية.

اتبع الأقسام أدناه من أجل

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

بعد الانتهاء من هذه الخطوات، يمكنك الدخول إلى مستندات 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 وBusiness Messages API

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

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

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

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

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

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

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

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

استبدِل API_KEY بمفتاح واجهة برمجة التطبيقات.