প্রকাশনা সংক্রান্ত ওভারভিউ

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন দেখুন। তথ্য

প্রকাশ করা হল এমন একটি প্রসেস যার মাধ্যমে আপনার API, অ্যাপ ডেভেলপারদের কাছে ব্যবহার করার জন্য উপলভ্য করা হয়।

ভিডিও: নিম্নলিখিত ভিডিওতে API প্রকাশনা সম্পর্কে একটি উচ্চ-স্তরের ভূমিকা প্রদান করা হয়েছে।

প্রকাশনা API-তে নিম্নলিখিত কাজগুলি অন্তর্ভুক্ত থাকে, যা এই বিষয়ে বর্ণনা করা হয়েছে:

  1. Edge-এ API প্রোডাক্ট তৈরি করুন যা আপনার API-কে বান্ডেল করে।
  2. Edge-এ অ্যাপ ডেভেলপারদের রেজিস্টার করুন।
  3. Edge-এ ডেভেলপার অ্যাপ রেজিস্টার করুন।
  4. আপনার API-এর জন্য ডকুমেন্টেশন ও কমিউনিটি সহায়তা প্রদান করুন।

টাস্ক ১: Edge-এ API প্রোডাক্ট তৈরি করা

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

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

এই ছবিতে, API-তে দুটি প্রোডাক্ট আছে, প্রত্যেকটিতে তিনটি API রিসোর্স আছে।

API প্রদানকারী হিসেবে, অ্যাক্সেস কন্ট্রোল, ব্যবহার সংক্রান্ত বিধিনিষেধ এবং অন্য কোনও ব্যবসায়িক প্রয়োজনীয়তা মোকাবেলা করার জন্য API এবং API প্রোডাক্ট তৈরি করার দায়িত্ব আপনার। যেমন, আপনি এগুলি করতে পারেন:

  • একটি ফ্রি API প্রোডাক্ট রিলিজ করুন যা API রিসোর্সে শুধু পড়ার অ্যাক্সেস দেয়।
  • কম দামে দ্বিতীয় API প্রোডাক্ট রিলিজ করুন যা ফ্রি ভার্সনের মতো একই API রিসোর্সে রিড/রাইট অ্যাক্সেস দেয়, তবে অ্যাক্সেস করার সীমা কম থাকে, যেমন, প্রতিদিন ১০০০টি অনুরোধ।
  • আরও বেশি দামের একটি থার্ড-পার্টি API প্রোডাক্ট প্রকাশ করুন যা একই API রিসোর্সকে রিড/রাইট অ্যাক্সেস করার অনুমতি দেয় তবে একটি উচ্চ অ্যাক্সেস সীমা সহ।

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

API প্রোডাক্ট তৈরি করা সম্পর্কে আরও তথ্য পেতে, API প্রোডাক্ট তৈরি করুন দেখুন।

টাস্ক ২: Edge-এ অ্যাপ ডেভেলপারকে রেজিস্টার করা

ডেভেলপাররা এমন অ্যাপ তৈরি করেন যা আপনার API ব্যবহার করে। অ্যাপ ডেভেলপারকে তার অ্যাপ রেজিস্টার করার আগে Apigee Edge-এ রেজিস্টার করতে হয়। অ্যাপ রেজিস্টার করার সময়, তিনি একটি API কী পান যা অ্যাপটিকে API অ্যাক্সেস করতে দেয়।

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

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

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

এছাড়াও, Apigee এমন টুল প্রদান করে যা আপনি ডেভেলপার রেজিস্ট্রেশন প্রসেস অটোমেট করতে ব্যবহার করতে পারেন। যেমন:

  • আপনার আগে থেকে থাকা ওয়েবসাইটে রেজিস্ট্রেশন কার্যকারিতা ইন্টিগ্রেট করতে Apigee Edge ম্যানেজমেন্ট API ব্যবহার করুন। Edge Management API হল একটি REST API যা আপনি ডেভেলপার রেজিস্ট্রেশন প্রসেসের সব দিক পারফর্ম করতে ব্যবহার করতে পারেন। আরও জানতে API প্রকাশ করার জন্য Edge Management API ব্যবহার করা দেখুন।
  • ডেভেলপারদের রেজিস্টার করতে Apigee Developer Services পোর্টাল ব্যবহার করুন। এই পোর্টালটি ডেভেলপার রেজিস্ট্রেশনের জন্য বিল্ট-ইন সাপোর্ট প্রদান করে, তবে আপনার API-কে সাপোর্ট করার জন্য এতে আরও অনেক ফিচার রয়েছে। আরও জানতে ডেভেলপার পোর্টাল কী? লিঙ্কে দেখুন।

টাস্ক ৩: Edge-এ ডেভেলপার অ্যাপ রেজিস্টার করা

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

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

অ্যাপ রেজিস্ট্রেশনের সময়, ডেভেলপার এক বা একাধিক API প্রোডাক্ট বেছে নেন। যেমন, আপনি বিভিন্ন ধরনের পরিষেবা ও মূল্যের প্ল্যান অনুযায়ী একাধিক API প্রোডাক্ট প্রকাশ করতে পারেন। অ্যাপ ডেভেলপার তারপর উপলভ্য API প্রোডাক্টের তালিকা থেকে বেছে নিতে পারবেন।

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

API প্রদানকারী হিসেবে, আপনি কীভাবে অ্যাপ রেজিস্টার করতে চান সেই বিষয়ে সিদ্ধান্ত নেন। আপনি এগুলি করতে পারেন:

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

আরও তথ্যের জন্য, অ্যাপ রেজিস্টার করা ও API কী ম্যানেজ করা দেখুন।

টাস্ক ৪: আপনার API-এর ডকুমেন্টেশন তৈরি করুন

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

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

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

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

  • API সম্পর্কে পড়ুন
  • API-তে লাইভ অনুরোধ পাঠানো
  • API থেকে পাওয়া লাইভ উত্তর দেখুন

যেমন, নিম্নলিখিত ছবিতে SmartDocs ব্যবহার করে পোর্টালে ডকুমেন্ট করা একটি API দেখানো হয়েছে। এই API নির্দিষ্ট লোকেশনের আবহাওয়া সংক্রান্ত তথ্য প্রদান করে:

SmartDocs API পদ্ধতির বিষয় যা আপনাকে কোনও বিষয়ের মধ্যে থাকা বোতামে ক্লিক করে আবহাওয়া API কল করতে দেয়।

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

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

আরও তথ্যের জন্য, API ডকুমেন্ট করার জন্য SmartDocs ব্যবহার করা দেখুন।