বহিরাগত API অনুরোধ

বাহ্যিক API অনুরোধগুলি আপনাকে অনুরোধের টেমপ্লেটগুলিকে সংজ্ঞায়িত করার অনুমতি দেয় এবং তারপরে ব্যবসায়িক প্রক্রিয়াগুলির মধ্যে থেকে যেকোনো API-তে বহির্গামী কলগুলি ট্রিগার করে৷ তাদের সাথে, আপনি আপনার প্রোজেক্টকে যেকোন তৃতীয় পক্ষের পরিষেবার সাথে সংযুক্ত করতে পারেন, এমনকি যদি বাজারে এখনও এটির জন্য কোনও মডিউল বিদ্যমান না থাকে।

সংজ্ঞা

আপনি যে পরিষেবা প্রদানকারীর সাথে সংযোগ করতে চান তার API ডকুমেন্টেশনে অনুরোধটি কীভাবে গঠন করা উচিত তার স্পেসিফিকেশনগুলি দেখুন৷

1. একটি নতুন অনুরোধ টেমপ্লেট সংজ্ঞায়িত করতে, সাইডবারে "বিজনেস লজিক" ট্যাবে যান (1), "বহিরাগত API অনুরোধ" ট্যাবে স্যুইচ করুন (2), এবং "নতুন API অনুরোধ" (3) এ ক্লিক করুন।

2. নতুন অনুরোধটিকে একটি নাম দিন এবং ঐচ্ছিকভাবে একটি বিবরণ দিন৷

3. অনুরোধ HTTP পদ্ধতি এবং এর URL নির্বাচন করুন।

4. URL প্যারামিটার, ক্যোয়ারী প্যারামিটার (শুধুমাত্র GET অনুরোধের জন্য), হেডার এবং অনুরোধের মূল অংশটি প্যারামিটারের নাম (1), এর ধরন (2) ইনপুট করে এবং "পরাম যোগ করুন" (3) ক্লিক করে সংজ্ঞায়িত করুন।

এই পরামিতিগুলির প্রকৃত মান ব্যবসায়িক প্রক্রিয়াটি সম্পাদনের সময় সংজ্ঞায়িত করা হবে, যেখানে অনুরোধটি ট্রিগার করা হয়।

URL এবং ক্যোয়ারী প্যারামিটারের মধ্যে পার্থক্য বুঝতে, এখানে আরও পড়ুন। যদিও স্ট্যান্ডার্ড যাই হোক না কেন, আপনি যে পরিষেবা প্রদানকারীর সাথে সংযোগ করতে চান তার API ডকুমেন্টেশন হল অনুরোধটি কীভাবে তৈরি করা যায় সে সম্পর্কে তথ্যের সর্বোত্তম উৎস।

আপনি নমুনা JSON ইনপুট করে অনুরোধ শিরোনাম এবং বডি স্বয়ংক্রিয়ভাবে পূরণ করতে পারেন, সিস্টেম স্বয়ংক্রিয়ভাবে সমস্ত প্রয়োজনীয় পরামিতি তৈরি করবে।

আপনাকে প্রতিটি ট্যাবে নতুন প্যারামিটার যোগ করতে হবে না। কিছু অনুরোধে কোনো URL প্যারামিটার, শিরোনাম বা বডি একেবারেই নাও থাকতে পারে, উদাহরণস্বরূপ।

যদি আপনার অনুরোধে বস্তুগুলি থাকে (যেমন গাড়ি -> রঙ, আকার, ইত্যাদি), আপনাকে পরবর্তীতে আপনার ব্যবসায়িক প্রক্রিয়াগুলিতে এই বস্তুগুলি প্রক্রিয়া করার জন্য ভার্চুয়াল মডেল তৈরি করতে হবে৷ প্যারামিটার টাইপ সিলেক্টরে "মডেল" নির্বাচন করে এবং আপনার প্রয়োজন হবে এমন চাইল্ড উপাদানগুলি প্রবর্তন করে এটি করুন৷ আপনি যতবার প্রয়োজন ততবার অবজেক্ট নেস্ট করতে পারেন (অর্থাৎ অবজেক্টের মধ্যে অবজেক্ট) এবং ভার্চুয়াল মডেল অ্যারে তৈরি করতে পারেন। আপনি অটোফিল ব্যবহার করে থাকলে, এই প্রক্রিয়াটি স্বয়ংক্রিয়ভাবে সম্পন্ন হয়েছিল।

5. অনুরোধের সেটিংস পরিবর্তন করুন, যেমন "সেটিংস" ট্যাবে SSL যাচাইকরণ, সময়সীমা, এবং ত্রুটি পরিচালনা।

6. "Test Request"-এ ক্লিক করে এবং সমস্ত প্রয়োজনীয় প্যারামিটার ইনপুট করে অনুরোধটি পরীক্ষা করুন৷ সার্ভার থেকে প্রতিক্রিয়া পরীক্ষা করুন এবং স্বয়ংক্রিয়ভাবে প্রতিক্রিয়া শিরোনাম এবং বডি স্বয়ংক্রিয়ভাবে পূরণ করুন, অথবা ম্যানুয়ালি করুন।

7. "অনুরোধ সংরক্ষণ করুন" ক্লিক করে অনুরোধ টেমপ্লেটটি সংরক্ষণ করুন৷

ব্যবহার করুন

আপনি একটি নতুন অনুরোধ সংজ্ঞায়িত এবং সংরক্ষণ করার পরে, এটি ট্রিগার করার জন্য একটি নতুন ব্লক বিজনেস প্রসেস এডিটরে উপলব্ধ হবে৷

ডেটা মডেল হিসাবে আপনি অনুরোধে (URL এবং ক্যোয়ারী প্যারামিটার, হেডার এবং বডি) যোগ করতে চান এমন সমস্ত উপাদান দিয়ে আপনাকে এটি সরবরাহ করতে হবে, যা এই ব্লকগুলি ব্যবহার করে তৈরি করা যেতে পারে। আউটপুটে, আপনি রেসপন্সের ফরম্যাট করা বডি, এর হেডার এবং রেসপন্স স্ট্যাটাস বের করতে পারবেন। আপনি এই ব্লকগুলি ব্যবহার করে এই মডেলগুলি প্রসারিত করতে পারেন।

অনুরোধটি সঠিকভাবে ট্রিগার করার জন্য আপনাকে সমস্ত ডেটা ইনপুট সংযোগ করতে হবে না। উদাহরণস্বরূপ, যদি আপনার কাছে কোনো URL প্যারামিটার ছাড়াই অনুরোধ থাকে, তাহলে আপনাকে এর মডেল তৈরি করতে হবে না এবং এটি সংযুক্ত করতে হবে না।

আপনার সংজ্ঞায়িত প্রতিটি ভার্চুয়াল মডেলের জন্য, এটি তৈরি এবং প্রসারিত করার জন্য আপনার ব্যবসায়িক প্রক্রিয়া সম্পাদকে 2টি নতুন ব্লক যোগ করা হবে।

মনিটরিং

প্রতিবার যখন আপনি একটি API অনুরোধ ট্রিগার করবেন, সিস্টেমটি লগগুলিতে তার ধরন এবং ঠিকানা, অনুরোধের মূল অংশ, প্রতিক্রিয়া HTTP স্ট্যাটাস কোড এবং প্রতিক্রিয়া বডি আউটপুট করবে। আপনি অন্যান্য তথ্য আউটপুট করতে পারেন, যেমন রেসপন্স বডির নির্দিষ্ট ক্ষেত্র, বা লগে লিখতে লেটেন্সি ব্লক ব্যবহার করে।