এই পৃষ্ঠাটি Cloud Translation API অনুবাদ করেছে।

প্রকাশনা ওভারভিউ

আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।

পাবলিশিং হলো অ্যাপ ডেভেলপারদের ব্যবহারের জন্য আপনার এপিআই-গুলো উপলব্ধ করার প্রক্রিয়া।

ভিডিও: নিম্নলিখিত ভিডিওটিতে এপিআই পাবলিশিং সম্পর্কে একটি প্রাথমিক ধারণা দেওয়া হয়েছে।

এপিআই প্রকাশ করার সাথে নিম্নলিখিত কাজগুলো জড়িত, যা এই বিষয়ে বর্ণনা করা হয়েছে:

Edge-এ এমন API প্রোডাক্ট তৈরি করুন যা আপনার API-গুলোকে বান্ডল করবে।
Edge-এ অ্যাপ ডেভেলপারদের নিবন্ধন করুন।
Edge-এ ডেভেলপার অ্যাপ নিবন্ধন করুন।
আপনার এপিআইগুলোর জন্য ডকুমেন্টেশন এবং কমিউনিটি সাপোর্ট প্রদান করুন।

কাজ ১: Edge-এ একটি API পণ্য তৈরি করুন

পাবলিশিং-এর প্রথম কাজ হলো একটি এপিআই প্রোডাক্ট তৈরি করা। এপিআই প্রোডাক্ট হলো এপিআই রিসোর্সসমূহের একটি সংগ্রহ, যা অ্যাপ ডেভেলপারদের ব্যবহারের জন্য একটি প্যাকেজ হিসেবে অফার করা হয়। Edge ম্যানেজমেন্ট এপিআই বা UI ব্যবহার করে এপিআই প্রোডাক্ট তৈরি করুন। (এপিআই প্রোডাক্ট সম্পর্কে আরও জানতে ‘এপিআই প্রোডাক্ট কী? ’ দেখুন।)

এই চিত্রে, এপিআইটি দুটি পণ্য নিয়ে গঠিত, যার প্রতিটিতে তিনটি এপিআই রিসোর্স রয়েছে।

একজন এপিআই প্রোভাইডার হিসেবে, অ্যাক্সেস কন্ট্রোল, ব্যবহারের সীমাবদ্ধতা এবং অন্য যেকোনো ব্যবসায়িক প্রয়োজনীয়তা পূরণের জন্য এপিআই ও এপিআই প্রোডাক্ট তৈরি করার দায়িত্ব আপনার। উদাহরণস্বরূপ, আপনি যা করতে পারেন:

এমন একটি ফ্রি এপিআই প্রোডাক্ট প্রকাশ করুন যা এর এপিআই রিসোর্সগুলোতে শুধুমাত্র পঠনযোগ্য (read-only) অ্যাক্সেস দেয়।
কম দামে একটি দ্বিতীয় এপিআই পণ্য চালু করুন যা ফ্রি ভার্সনের মতোই একই এপিআই রিসোর্সগুলিতে রিড/রাইট অ্যাক্সেস দেবে, কিন্তু অ্যাক্সেসের সীমা কম থাকবে, যেমন প্রতিদিন ১০০০টি অনুরোধ।
আরও বেশি দামে একটি তৃতীয় এপিআই পণ্য চালু করুন যা একই এপিআই রিসোর্সে রিড/রাইট অ্যাক্সেস দেবে, কিন্তু একটি উচ্চ অ্যাক্সেস সীমা সহ।

মনে রাখার গুরুত্বপূর্ণ বিষয়টি হলো, Edge আপনাকে এমন API প্রোডাক্ট তৈরি করার নমনীয়তা দেয় যা আপনার API-এর ব্যবসায়িক প্রয়োজনীয়তার সাথে মেলে।

এপিআই প্রোডাক্ট তৈরি করার বিষয়ে আরও তথ্যের জন্য, “এপিআই প্রোডাক্ট তৈরি করুন” দেখুন।

কাজ ২: Edge-এ একজন অ্যাপ ডেভেলপারকে নিবন্ধন করুন

একজন ডেভেলপার সেই অ্যাপগুলো তৈরি করেন যেগুলো আপনার এপিআই (API) ব্যবহার করে। একজন অ্যাপ ডেভেলপার তার অ্যাপ নিবন্ধন করার আগে Apigee Edge-এ নিবন্ধন করেন। যখন তারা তাদের অ্যাপ নিবন্ধন করেন, তখন তারা একটি এপিআই কী (API key) পান যা অ্যাপটিকে এপিআই-তে অ্যাক্সেস দেবে।

অ্যাপ নিবন্ধন প্রক্রিয়ার মাধ্যমে, আপনি নিয়ন্ত্রণ করেন কে আপনার এপিআই (API)-গুলোতে অ্যাক্সেস পাবে। আপনি যেকোনো সময় একজন অ্যাপ ডেভেলপারকে মুছে ফেলতে পারেন, যা সেই ডেভেলপারের সাথে যুক্ত সমস্ত এপিআই কী (API key)-কে অবৈধ করে দেয় এবং এর ফলে সেই ডেভেলপার আপনার এপিআই-গুলোতে অ্যাক্সেস পায় না।

একজন এপিআই প্রোভাইডার হিসেবে, আপনিই ঠিক করেন কীভাবে ডেভেলপারদের রেজিস্টার করবেন। উদাহরণস্বরূপ, আপনি একটি ম্যানুয়াল রেজিস্ট্রেশন প্রক্রিয়া ব্যবহার করতে পারেন, যেখানে একজন সম্ভাব্য ডেভেলপারকে রেজিস্টার করার জন্য আপনার সংস্থার সাথে যোগাযোগ করতে হবে। সম্ভাব্য ডেভেলপারকে অবশ্যই সমস্ত প্রয়োজনীয় তথ্য, যেমন একটি ইমেল অ্যাড্রেস, প্রথম ও শেষ নাম এবং কোম্পানির নাম সরবরাহ করতে হবে। আপনি যদি ডেভেলপারের অনুরোধটি অনুমোদন করেন, তবে আপনি Edge ম্যানেজমেন্ট UI ব্যবহার করে ডেভেলপারকে ম্যানুয়ালি রেজিস্টার করতে পারেন। আরও তথ্যের জন্য ‘অ্যাপ ডেভেলপারদের পরিচালনা’ দেখুন।

Apigee এমন কিছু টুলও প্রদান করে যা ব্যবহার করে আপনি ডেভেলপার নিবন্ধন প্রক্রিয়াটি স্বয়ংক্রিয় করতে পারেন। উদাহরণস্বরূপ:

আপনার বিদ্যমান ওয়েবসাইটে রেজিস্ট্রেশন কার্যকারিতা সংহত করতে Apigee Edge ম্যানেজমেন্ট API ব্যবহার করুন। Edge ম্যানেজমেন্ট API হলো একটি REST API যা আপনি ডেভেলপার রেজিস্ট্রেশন প্রক্রিয়ার সমস্ত দিক সম্পাদন করতে ব্যবহার করতে পারেন। আরও জানতে "Using the Edge management API to Publish APIs" দেখুন।
ডেভেলপারদের নিবন্ধন করতে Apigee ডেভেলপার সার্ভিসেস পোর্টাল ব্যবহার করুন। এই পোর্টালে ডেভেলপার নিবন্ধনের জন্য অন্তর্নির্মিত ব্যবস্থা তো আছেই, এছাড়াও আপনার এপিআই (API)-গুলোকে সমর্থন করার জন্য এতে আরও অনেক বৈশিষ্ট্য রয়েছে। আরও জানতে ‘ডেভেলপার পোর্টাল কী?’ দেখুন।

কাজ ৩: Edge-এ একটি ডেভেলপার অ্যাপ নিবন্ধন করুন

কোনো অ্যাপ আপনার এপিআই (API) অ্যাক্সেস করার আগে, অ্যাপটিকে অবশ্যই এজ (Edge)-এ নিবন্ধিত হতে হবে। তবে, শুধুমাত্র একজন নিবন্ধিত ডেভেলপারই এজ-এ একটি অ্যাপ নিবন্ধন করতে পারেন।

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

দ্রষ্টব্য: Edge-এ ডেভেলপারকে একটি অ্যাপের সাথে একাধিক API প্রোডাক্ট যুক্ত করার অনুমতি দেওয়ার প্রয়োজন নেই। আপনার পাবলিশিং প্ল্যানটি এমনভাবে সাজানো যেতে পারে যাতে ডেভেলপার শুধুমাত্র একটি API প্রোডাক্ট নির্বাচন করতে পারেন। অথবা, আপনি সমস্ত অ্যাপে স্বয়ংক্রিয়ভাবে একটি ডিফল্ট API প্রোডাক্ট নির্ধারণ করে দিতে পারেন, যাতে ডেভেলপারকে কোনো একটি বেছে নেওয়ার সুযোগই না থাকে।

Edge-এ অ্যাপটি নিবন্ধন করার প্রতিক্রিয়ায়, Edge অ্যাপটিকে একটি অনন্য API কী প্রদান করে। অ্যাপটিকে অবশ্যই প্রতিটি API রিসোর্সের অনুরোধের অংশ হিসেবে সেই API কী-টি প্রদান করতে হবে। কী-টি প্রমাণীকরণ করা হয় এবং বৈধ হলে অনুরোধটি মঞ্জুর করা হয়। পরিষেবা প্রদানকারী হিসেবে আপনি যেকোনো সময় কী-টি বাতিল করতে পারেন, যাতে অ্যাপটি আর আপনার API-গুলো অ্যাক্সেস করতে না পারে।

এপিআই প্রোভাইডার হিসেবে, আপনিই ঠিক করবেন কীভাবে অ্যাপগুলো রেজিস্টার করবেন। আপনি করতে পারেন:

এমন একটি ম্যানুয়াল পদ্ধতি ব্যবহার করুন, যার মাধ্যমে কোনো ডেভেলপারকে তাদের অ্যাপ নিবন্ধন করার জন্য আপনার প্রতিষ্ঠানের সাথে যোগাযোগ করতে হবে। এর জবাবে, আপনি ডেভেলপারকে এপিআই কী (API key) পাঠিয়ে দেবেন, যা সম্ভবত ইমেলের মাধ্যমে করা যেতে পারে।
আপনার ওয়েবসাইটে অ্যাপ রেজিস্ট্রেশন কার্যকারিতা এবং কী ডেলিভারি সংহত করতে এজ ম্যানেজমেন্ট এপিআই ব্যবহার করুন।
পেইড Edge অ্যাকাউন্টের জন্য Apigee ডেভেলপার সার্ভিসেস পোর্টালটি ব্যবহার করুন, যেটিতে অ্যাপ রেজিস্ট্রেশন এবং এপিআই কী ডেলিভারির জন্য বিল্ট-ইন সাপোর্ট রয়েছে।

দ্রষ্টব্য: একটি উত্তম অনুশীলন হিসেবে, ডেভেলপার Edge-এ যে অ্যাপটি নিবন্ধন করেন এবং তিনি যে প্রকৃত ক্লায়েন্ট অ্যাপটি তৈরি করেন, তার মধ্যে একটি ১-১ সম্পর্ক থাকে। তবে, Edge এই সম্পর্কটি বলবৎ করে না। উদাহরণস্বরূপ, একজন ডেভেলপার Edge-এ একটিমাত্র অ্যাপ নিবন্ধন করেন, সেই অ্যাপটিকে একটি API প্রোডাক্টের সাথে যুক্ত করেন এবং একটি API কী ফেরত পান। ডেভেলপার যেকোনো ক্লায়েন্ট অ্যাপ থেকে সেই API কী ব্যবহার করতে স্বাধীন।

আরও তথ্যের জন্য, অ্যাপ নিবন্ধন করুন এবং এপিআই কী পরিচালনা করুন দেখুন।

কাজ ৪: আপনার API-গুলো নথিভুক্ত করুন

এপিআই প্রোডাক্ট প্রকাশের ক্ষেত্রে ডকুমেন্টেশন এবং ডেভেলপারদের মতামত জানানোর ব্যবস্থা রাখা একটি গুরুত্বপূর্ণ বিষয়। ডেভেলপমেন্ট কমিউনিটির সাথে যোগাযোগের জন্য সোশ্যাল পাবলিশিং ফিচারযুক্ত ডেভেলপার পোর্টালগুলো ক্রমবর্ধমানভাবে ব্যবহৃত হচ্ছে। এর মধ্যে রয়েছে এপিআই ডকুমেন্টেশন ও ব্যবহারের শর্তাবলীর মতো স্ট্যাটিক কন্টেন্ট, ব্লগ ও ফোরামের মতো কমিউনিটি-প্রদত্ত ডাইনামিক কন্টেন্ট এবং কাস্টমার সাপোর্ট ফিচারের প্রচার।

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

SmartDocs আপনাকে ডেভেলপার সার্ভিসেস পোর্টালে আপনার API-গুলো এমনভাবে ডকুমেন্ট করার সুযোগ দেয়, যা API ডকুমেন্টেশনকে সম্পূর্ণ ইন্টারেক্টিভ করে তোলে। SmartDocs-এর ইন্টারেক্টিভ ডকুমেন্টেশনের মাধ্যমে পোর্টাল ব্যবহারকারীরা যা করতে পারেন:

এপিআই সম্পর্কে পড়ুন
এপিআই-তে একটি লাইভ অনুরোধ পাঠান
এপিআই থেকে প্রাপ্ত লাইভ প্রতিক্রিয়া দেখুন

উদাহরণস্বরূপ, নিচের চিত্রে SmartDocs ব্যবহার করে পোর্টালে নথিভুক্ত একটি API দেখানো হয়েছে। এই API-টি একটি নির্দিষ্ট স্থানের আবহাওয়ার তথ্য প্রদান করে:

একটি SmartDocs API মেথড টপিক যা আপনাকে টপিকের মধ্যে থাকা একটি বাটনে ক্লিক করে ওয়েদার API কল করার সুযোগ দেয়।

ডেভেলপার অবস্থান নির্দিষ্ট করার জন্য 'w' কোয়েরি প্যারামিটারে একটি মান প্রবেশ করান এবং তারপর লাইভ অনুরোধ ও প্রতিক্রিয়া দেখতে 'অনুরোধ পাঠান ' বোতামে ক্লিক করেন। আপনার এপিআই-গুলোর উপর একটি ইন্টারেক্টিভ ডকুমেন্টেশন তৈরি করার মাধ্যমে, আপনি পোর্টাল ব্যবহারকারীদের জন্য আপনার এপিআই-গুলো শেখা, পরীক্ষা করা এবং মূল্যায়ন করা সহজ করে তোলেন।

এজ ম্যানেজমেন্ট এপিআই হলো একটি REST এপিআই যা আপনাকে যেকোনো HTTP ক্লায়েন্ট ব্যবহার করে এপিআই সার্ভিসগুলো অ্যাক্সেস করতে সক্ষম করে। Apigee, এজ ম্যানেজমেন্ট এপিআই-এর জন্য ইন্টারেক্টিভ ডকুমেন্টেশন তৈরি করতে SmartDocs ব্যবহার করে। সেই এপিআই ডকুমেন্টেশনটি এখানে দেখুন।

আরও তথ্যের জন্য, এপিআই ডকুমেন্ট করতে স্মার্টডকস-এর ব্যবহার দেখুন।