OpenAPI হল REST API বর্ণনা করার জন্য একটি স্পেসিফিকেশন। OpenAPI স্পেসিফিকেশন 2.0 ব্যবহার করে, আপনি ব্যবসা বার্তা এবং বিজনেস কমিউনিকেশন API-এর গঠন বর্ণনা করার জন্য OpenAPI নথি তৈরি করতে পারেন।
এটি আপনাকে নিম্নলিখিতগুলি করতে দেয়:
- আপনার পছন্দের ভাষায় ক্লায়েন্ট লাইব্রেরি তৈরি করুন
- সার্ভার স্টাব তৈরি করুন
- 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 নথিগুলি অ্যাক্সেস করার জন্য, আপনার কাছে Google ক্লাউড প্ল্যাটফর্ম (GCP) প্রকল্পের একটি API কী থাকতে হবে যাতে ব্যবসা বার্তা এবং বিজনেস কমিউনিকেশন API সক্রিয় থাকে৷
নীচের বিভাগগুলি অনুসরণ করুন
- একটি GCP প্রকল্প তৈরি করুন
- একটি API কী তৈরি করুন
- ব্যবসা বার্তা API এবং ব্যবসায়িক যোগাযোগ API সক্ষম করুন৷
এই পদক্ষেপগুলি সম্পন্ন হলে, আপনি OpenAPI নথিগুলি অ্যাক্সেস করতে পারেন।
একটি GCP প্রকল্প তৈরি করুন
আপনার যদি ইতিমধ্যে একটি GCP প্রকল্প থাকে, তাহলে আপনি একটি API কী তৈরি করতে এটি ব্যবহার করতে পারেন।
একটি নতুন GCP প্রকল্প তৈরি করতে, নিম্নলিখিতগুলি করুন:
- GCP কনসোলে সম্পদ পরিচালনা পৃষ্ঠাতে নেভিগেট করুন।
- পৃষ্ঠার শীর্ষে সংস্থা নির্বাচন করুন ড্রপ-ডাউন তালিকায়, আপনি যে সংস্থাটির জন্য প্রকল্পটি তৈরি করতে চান সেটি নির্বাচন করুন৷ আপনি যদি একজন ফ্রি-ট্রায়াল ব্যবহারকারী হন, তাহলে এই ধাপটি এড়িয়ে যান।
- প্রকল্প তৈরি করুন ক্লিক করুন।
- নতুন প্রকল্প উইন্ডোতে, একটি প্রকল্পের নাম লিখুন এবং প্রযোজ্য হিসাবে একটি বিলিং অ্যাকাউন্ট নির্বাচন করুন৷ একটি প্রকল্পের নামে শুধুমাত্র অক্ষর, সংখ্যা, একক উদ্ধৃতি, হাইফেন, স্পেস বা বিস্ময়বোধক বিন্দু থাকতে পারে এবং অবশ্যই 4 থেকে 30 অক্ষরের মধ্যে হতে হবে।
অবস্থানের জন্য, নতুন প্রকল্পের জন্য মূল সংস্থা বা ফোল্ডারে প্রবেশ করুন৷
তৈরি করুন ক্লিক করুন ।
একটি API কী তৈরি করুন
GCP কনসোলে শংসাপত্র পৃষ্ঠাতে নেভিগেট করুন।
ক্রেডেনশিয়াল তৈরি করুন ক্লিক করুন, তারপর API কী নির্বাচন করুন।
API কী তৈরি করা ডায়ালগ বক্স আপনার নতুন তৈরি কী প্রদর্শন করে। আপনার কী অনুলিপি করুন এবং এটি সুরক্ষিত রাখুন। API কী সম্পর্কে আরও জানতে, API কী ডকুমেন্টেশন দেখুন।
ব্যবসায়িক যোগাযোগ API এবং ব্যবসা বার্তা API সক্ষম করুন৷
আপনার GCP প্রকল্পে এই APIগুলি সক্ষম করতে, নিম্নলিখিতগুলি করুন:
- GCP কনসোলে APIs এবং পরিষেবা পৃষ্ঠাতে যান।
- প্রকল্প নির্বাচন করুন ড্রপ-ডাউন তালিকায়, আপনি যে প্রকল্পটির জন্য API সক্ষম করতে চান সেটি নির্বাচন করুন।
- API এবং পরিষেবাগুলি সক্ষম করুন ক্লিক করুন৷
- APIs এবং পরিষেবাগুলির জন্য অনুসন্ধান ক্ষেত্রে, ব্যবসা বার্তা লিখুন।
- ব্যবসা বার্তা API নির্বাচন করুন।
- সক্ষম করুন ক্লিক করুন।
- API এবং পরিষেবাগুলি সক্ষম করুন ক্লিক করুন৷
- APIs এবং পরিষেবাগুলির জন্য অনুসন্ধান ক্ষেত্রে, ব্যবসায়িক যোগাযোগ লিখুন।
- ব্যবসায়িক যোগাযোগ API নির্বাচন করুন।
- সক্ষম করুন ক্লিক করুন।
এখন আপনার API কী-তে ব্যবসা বার্তা এবং ব্যবসায়িক যোগাযোগ API-এর জন্য OpenAPI নথি অ্যাক্সেস করার অনুমতি রয়েছে।
OpenAPI নথি অ্যাক্সেস করুন
Business Messages API-এর জন্য OpenAPI নথি অ্যাক্সেস করতে এই কমান্ডটি চালান:
curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"
বিজনেস কমিউনিকেশন API এর জন্য OpenAPI ডকুমেন্ট অ্যাক্সেস করতে এই কমান্ডটি চালান:
curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"
আপনার API কী দিয়ে API_KEY প্রতিস্থাপন করুন।