আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশনে যান । তথ্য
প্রকাশনা হল অ্যাপ ডেভেলপারদের ব্যবহারের জন্য আপনার APIগুলি উপলব্ধ করার প্রক্রিয়া৷
ভিডিও: নিম্নলিখিত ভিডিওটি API প্রকাশনার একটি উচ্চ-স্তরের ভূমিকা প্রদান করে।
এপিআই প্রকাশ করার ক্ষেত্রে এই বিষয়ে বর্ণিত নিম্নলিখিত কাজগুলি জড়িত:
- এজে API পণ্যগুলি তৈরি করুন যা আপনার APIগুলিকে বান্ডিল করে৷
- এজে অ্যাপ ডেভেলপারদের নিবন্ধন করুন।
- এজে ডেভেলপার অ্যাপস নিবন্ধন করুন।
- আপনার API-এর জন্য ডকুমেন্টেশন এবং সম্প্রদায় সহায়তা প্রদান করুন।
টাস্ক 1: এজ এ একটি API পণ্য তৈরি করুন
প্রকাশনার প্রথম কাজটি হল একটি API পণ্য তৈরি করা। একটি API পণ্য হল API সংস্থানগুলির একটি সংগ্রহ যা অ্যাপ বিকাশকারীদের ব্যবহারের জন্য প্যাকেজ হিসাবে দেওয়া হয়। এজ ম্যানেজমেন্ট API বা UI ব্যবহার করে API পণ্য তৈরি করুন। ( এপিআই পণ্য কী? এপিআই পণ্য সম্পর্কে আরও জানতে দেখুন।)
এই চিত্রে, API দুটি পণ্য নিয়ে গঠিত, প্রতিটিতে তিনটি API সংস্থান রয়েছে।
একজন API প্রদানকারী হিসাবে, আপনি অ্যাক্সেস নিয়ন্ত্রণ, ব্যবহার বিধিনিষেধ এবং অন্যান্য ব্যবসার প্রয়োজনীয়তাগুলি পরিচালনা করার জন্য API এবং API পণ্যগুলি তৈরি করার জন্য দায়ী৷ উদাহরণস্বরূপ, আপনি হতে পারেন:
- একটি বিনামূল্যের API পণ্য প্রকাশ করুন যা এর API সংস্থানগুলিতে শুধুমাত্র-পঠন অ্যাক্সেসের অনুমতি দেয়৷
- একটি কম দামে একটি দ্বিতীয় API পণ্য প্রকাশ করুন যা বিনামূল্যে সংস্করণের মতো একই API সংস্থানগুলিতে পড়ার/লেখার অ্যাক্সেসের অনুমতি দেয় কিন্তু কম অ্যাক্সেস সীমা সহ, যেমন প্রতিদিন 1000টি অনুরোধ৷
- একটি উচ্চ মূল্যের জন্য একটি তৃতীয় API পণ্য প্রকাশ করুন যা একই API সংস্থান পড়ার/লেখার অ্যাক্সেসের অনুমতি দেয় তবে উচ্চ অ্যাক্সেস সীমা সহ।
মনে রাখা গুরুত্বপূর্ণ বিষয় হল এজ আপনাকে API পণ্যগুলি তৈরি করতে নমনীয়তা দেয় যা আপনার APIগুলির ব্যবসার প্রয়োজনীয়তার সাথে মেলে।
API পণ্য তৈরির বিষয়ে আরও তথ্যের জন্য, API পণ্য তৈরি করুন দেখুন।
টাস্ক 2: এজ-এ একটি অ্যাপ ডেভেলপার নিবন্ধন করুন
একজন ডেভেলপার এমন অ্যাপ তৈরি করে যা আপনার API ব্যবহার করে। একজন অ্যাপ ডেভেলপার অ্যাপিজি এজ-এ তাদের অ্যাপ রেজিস্টার করার আগে রেজিস্টার করে। যখন তারা তাদের অ্যাপ নিবন্ধন করে, তারা একটি API কী পায় যা অ্যাপটিকে API-তে অ্যাক্সেস দেবে।
অ্যাপ রেজিস্ট্রেশন প্রক্রিয়ার মাধ্যমে, আপনি আপনার API-এ কার অ্যাক্সেস আছে তা নিয়ন্ত্রণ করেন। যেকোন সময়ে, আপনি একটি অ্যাপ ডেভেলপার মুছে ফেলতে পারেন, যা সেই ডেভেলপারের সাথে যুক্ত সমস্ত API কীগুলিকে বাতিল করে, তাই সেই ডেভেলপারকে আপনার APIগুলিতে অ্যাক্সেস অস্বীকার করে৷
একজন API প্রদানকারী হিসাবে, আপনি কীভাবে বিকাশকারীদের নিবন্ধন করবেন তা নির্ধারণ করুন। উদাহরণস্বরূপ, আপনি একটি ম্যানুয়াল রেজিস্ট্রেশন প্রক্রিয়া ব্যবহার করতে পারেন যার জন্য একজন সম্ভাব্য বিকাশকারীকে নিবন্ধনের জন্য আপনার সংস্থার সাথে যোগাযোগ করতে হবে। সম্ভাব্য বিকাশকারীকে অবশ্যই সমস্ত প্রয়োজনীয় তথ্য সরবরাহ করতে হবে, যেমন একটি ইমেল ঠিকানা, প্রথম এবং শেষ নাম এবং কোম্পানির নাম। আপনি যদি বিকাশকারীর অনুরোধ অনুমোদন করেন, আপনি বিকাশকারীকে ম্যানুয়ালি নিবন্ধন করতে এজ ম্যানেজমেন্ট UI ব্যবহার করতে পারেন। আরও জানতে অ্যাপ ডেভেলপারদের পরিচালনা দেখুন।
Apigee এমন সরঞ্জামগুলিও সরবরাহ করে যা আপনি বিকাশকারী নিবন্ধকরণ প্রক্রিয়া স্বয়ংক্রিয় করতে ব্যবহার করতে পারেন। যেমন:
- আপনার বিদ্যমান ওয়েবসাইটে নিবন্ধন কার্যকারিতা একীভূত করতে Apigee Edge ব্যবস্থাপনা API ব্যবহার করুন। এজ ম্যানেজমেন্ট API হল একটি REST API যা আপনি বিকাশকারী নিবন্ধন প্রক্রিয়ার সমস্ত দিক সম্পাদন করতে ব্যবহার করতে পারেন। আরও জানতে এজ ম্যানেজমেন্ট এপিআই ব্যবহার করে এপিআই প্রকাশ করুন দেখুন।
- ডেভেলপারদের নিবন্ধন করতে Apigee ডেভেলপার সার্ভিসেস পোর্টাল ব্যবহার করুন। পোর্টালটিতে বিকাশকারী নিবন্ধনের জন্য অন্তর্নির্মিত সমর্থন রয়েছে, তবে আপনার APIগুলিকে সমর্থন করার জন্য আরও অনেক বৈশিষ্ট্য রয়েছে৷ দেখুন ডেভেলপার পোর্টাল কি? আরো জন্য
টাস্ক 3: এজে একটি ডেভেলপার অ্যাপ নিবন্ধন করুন
একটি অ্যাপ আপনার APIগুলি অ্যাক্সেস করার আগে, অ্যাপটিকে অবশ্যই এজ-এ নিবন্ধিত হতে হবে। যাইহোক, শুধুমাত্র একজন নিবন্ধিত বিকাশকারী এজে একটি অ্যাপ নিবন্ধন করতে পারেন।
অ্যাপ নিবন্ধনের সময়, বিকাশকারী এক বা একাধিক API পণ্য নির্বাচন করে। উদাহরণস্বরূপ, আপনি বিভিন্ন ধরণের পরিষেবা এবং মূল্য পরিকল্পনার সাথে সম্পর্কিত একাধিক API পণ্য প্রকাশ করতে পারেন। অ্যাপ বিকাশকারী তারপর উপলব্ধ API পণ্যগুলির তালিকা থেকে বাছাই করতে এবং চয়ন করতে পারেন৷
এজ-এ অ্যাপটি নিবন্ধন করার প্রতিক্রিয়া হিসেবে, এজ অ্যাপটিতে একটি অনন্য API কী বরাদ্দ করে। একটি API সম্পদে প্রতিটি অনুরোধের অংশ হিসেবে অ্যাপটিকে অবশ্যই সেই API কী পাস করতে হবে। কীটি প্রমাণীকৃত এবং বৈধ হলে, অনুরোধটি মঞ্জুর করা হয়। যেকোন সময়ে, আপনি পরিষেবা প্রদানকারী হিসাবে কীটি প্রত্যাহার করতে পারেন যাতে অ্যাপটি আর আপনার APIগুলি অ্যাক্সেস করতে না পারে৷
একজন API প্রদানকারী হিসাবে, আপনি কীভাবে অ্যাপগুলি নিবন্ধন করতে চান তা নির্ধারণ করুন। আপনি পারেন:
- একটি ম্যানুয়াল প্রক্রিয়া ব্যবহার করুন যাতে একজন বিকাশকারীকে তাদের অ্যাপ নিবন্ধন করতে আপনার সংস্থার সাথে যোগাযোগ করতে হয়। উত্তরে, আপনি সম্ভবত ইমেলের মাধ্যমে বিকাশকারীকে API কী পাঠাবেন।
- আপনার ওয়েবসাইটে অ্যাপ রেজিস্ট্রেশন কার্যকারিতা এবং কী ডেলিভারি সংহত করতে এজ ম্যানেজমেন্ট API ব্যবহার করুন।
- একটি প্রদত্ত এজ অ্যাকাউন্টের জন্য, অ্যাপিজি ডেভেলপার সার্ভিসেস পোর্টাল ব্যবহার করুন যা অ্যাপ রেজিস্ট্রেশন এবং এপিআই কী ডেলিভারির জন্য সমর্থন করে।
আরও তথ্যের জন্য, অ্যাপগুলি নিবন্ধন করুন এবং API কীগুলি পরিচালনা করুন দেখুন৷
টাস্ক 4: আপনার API গুলি নথিভুক্ত করুন
এপিআই পণ্য প্রকাশের জন্য একটি গুরুত্বপূর্ণ বিবেচ্য বিষয় হল ডকুমেন্টেশন এবং একটি ডেভেলপার ফিডব্যাক মেকানিজম প্রদান করা। সামাজিক প্রকাশনা বৈশিষ্ট্য সহ বিকাশকারী পোর্টালগুলি উন্নয়ন সম্প্রদায়ের সাথে যোগাযোগের জন্য ক্রমবর্ধমানভাবে ব্যবহৃত হচ্ছে। এর মধ্যে রয়েছে স্থির বিষয়বস্তু যোগাযোগ, যেমন API ডকুমেন্টেশন এবং ব্যবহারের শর্তাবলী, সেইসাথে ব্লগ এবং ফোরামের মতো গতিশীল সম্প্রদায়-অবদানকৃত বিষয়বস্তু, সেইসাথে গ্রাহক সহায়তা বৈশিষ্ট্যগুলি।
আপনি আপনার ডকুমেন্টেশন স্থাপন করার জন্য আপনার নিজস্ব ওয়েবসাইট তৈরি করতে পারেন বা, আপনার যদি একটি অর্থপ্রদত্ত এজ অ্যাকাউন্ট থাকে, আপনি Apigee ডেভেলপার সার্ভিসেস পোর্টাল ব্যবহার করতে পারেন। আপনার বিকাশকারী সম্প্রদায়কে সমর্থন করার জন্য প্রয়োজনীয় ডকুমেন্টেশন, ব্লগ, ফোরাম এবং অন্যান্য ধরণের সামগ্রীর জন্য পোর্টালটিতে অন্তর্নির্মিত সমর্থন রয়েছে।
SmartDocs আপনাকে বিকাশকারী পরিষেবা পোর্টালে আপনার APIগুলিকে এমনভাবে নথিভুক্ত করতে দেয় যা API ডকুমেন্টেশনকে সম্পূর্ণরূপে ইন্টারেক্টিভ করে তোলে। SmartDocs এর সাথে ইন্টারেক্টিভ ডকুমেন্টেশন মানে পোর্টাল ব্যবহারকারীরা করতে পারেন:
- API সম্পর্কে পড়ুন
- API এ একটি লাইভ অনুরোধ পাঠান
- API থেকে ফিরে আসা একটি লাইভ প্রতিক্রিয়া দেখুন
উদাহরণস্বরূপ, নিম্নলিখিত চিত্রটি SmartDocs ব্যবহার করে পোর্টালে নথিভুক্ত একটি API দেখায়। এই API একটি নির্দিষ্ট অবস্থানের জন্য আবহাওয়ার তথ্য প্রদান করে:
বিকাশকারী অবস্থান নির্দিষ্ট করার জন্য 'w' ক্যোয়ারী প্যারামিটারের জন্য একটি মান প্রবেশ করান এবং তারপর লাইভ অনুরোধ এবং প্রতিক্রিয়া দেখতে অনুরোধ পাঠান বোতামে ক্লিক করেন। আপনার API গুলিতে একটি ইন্টারেক্টিভ ডকুমেন্টেশন তৈরি করে, আপনি পোর্টাল ব্যবহারকারীদের জন্য আপনার APIগুলি শিখতে, পরীক্ষা করা এবং মূল্যায়ন করা সহজ করে তোলেন৷
এজ ম্যানেজমেন্ট API হল একটি REST API যা আপনাকে যেকোনো HTTP ক্লায়েন্ট ব্যবহার করে API পরিষেবাগুলি অ্যাক্সেস করতে সক্ষম করে। Apigee এজ ম্যানেজমেন্ট API এর জন্য ইন্টারেক্টিভ ডকুমেন্টেশন তৈরি করতে SmartDocs ব্যবহার করে। এখানে সেই API ডকুমেন্টেশন দেখুন।
আরও তথ্যের জন্য, APIs নথিতে SmartDocs ব্যবহার করা দেখুন।