OpenAPI مشخصاتی برای توصیف REST APIها است. با استفاده از مشخصات OpenAPI 2.0 ، می توانید اسناد OpenAPI را برای APIهای Business Messages و Business Communications ایجاد کنید تا ساختار آنها را توصیف کنید.
این به شما امکان می دهد کارهای زیر را انجام دهید:
- کتابخانه های مشتری را به زبان دلخواه خود ایجاد کنید
- ایجاد خرد سرور
- از ابزارهای مدیریت 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، به وب سایت Swagger مراجعه کنید .
نحوه دسترسی به اسناد OpenAPI
برای دسترسی به اسناد OpenAPI، باید یک کلید API از یک پروژه Google Cloud Platform (GCP) با فعال بودن APIهای پیام‌های تجاری و ارتباطات تجاری داشته باشید.
بخش های زیر را دنبال کنید تا
- یک پروژه GCP ایجاد کنید
- یک کلید API ایجاد کنید
- Business Messages API و Business Communications API را فعال کنید
با تکمیل این مراحل، می توانید به اسناد OpenAPI دسترسی داشته باشید .
یک پروژه GCP ایجاد کنید
اگر قبلاً یک پروژه GCP دارید، می‌توانید از آن برای ایجاد یک کلید API استفاده کنید.
برای ایجاد یک پروژه GCP جدید، موارد زیر را انجام دهید:
- به صفحه مدیریت منابع در کنسول GCP بروید.
- در لیست کشویی انتخاب سازمان در بالای صفحه، سازمانی را که می خواهید پروژه را برای آن ایجاد کنید، انتخاب کنید. اگر کاربر آزمایشی رایگان هستید، این مرحله را رد کنید.
- روی ایجاد پروژه کلیک کنید.
- در پنجره پروژه جدید ، نام پروژه را وارد کنید و حساب صورتحساب را انتخاب کنید. نام پروژه می تواند فقط شامل حروف، اعداد، نقل قول تکی، خط تیره، فاصله یا علامت تعجب باشد و باید بین 4 تا 30 کاراکتر باشد.
برای مکان ، سازمان یا پوشه والد پروژه جدید را وارد کنید.
روی ایجاد کلیک کنید.
یک کلید API ایجاد کنید
به صفحه اعتبارنامه در کنسول GCP بروید.
روی Create credentials کلیک کنید، سپس کلید API را انتخاب کنید.
کادر محاوره ای ایجاد شده با کلید API کلید تازه ایجاد شده شما را نمایش می دهد. کلید خود را کپی کنید و آن را ایمن نگه دارید. برای کسب اطلاعات بیشتر در مورد کلیدهای API، به مستندات کلید API مراجعه کنید.
Business Communications API و Business Messages API را فعال کنید
برای فعال کردن این APIها در پروژه GCP، موارد زیر را انجام دهید:
- به صفحه APIs & Services در کنسول GCP بروید.
- در لیست کشویی Select project ، پروژه ای را که می خواهید API ها را برای آن فعال کنید، انتخاب کنید.
- روی Enable APIs and Services کلیک کنید.
- در قسمت Search for APIs and Services ، Business Messages را وارد کنید.
- Business Messages API را انتخاب کنید.
- روی Enable کلیک کنید.
- روی Enable APIs and Services کلیک کنید.
- در قسمت Search for APIs and Services ، Business Communications را وارد کنید.
- Business Communications API را انتخاب کنید.
- روی Enable کلیک کنید.
اکنون کلید API شما مجوز دسترسی به اسناد OpenAPI برای پیام‌های تجاری و 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 خود جایگزین کنید.