ভূমিকা

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

নিম্নলিখিত বিভাগগুলি আপনাকে API পণ্য এবং সম্পর্কিত মূল ধারণাগুলির সাথে পরিচয় করিয়ে দেয়৷

একটি API পণ্য কি?

একজন API প্রদানকারী হিসাবে, আপনি আপনার APIগুলিকে বান্ডিল করার জন্য API পণ্যগুলি তৈরি করেন এবং সেগুলিকে অ্যাপ বিকাশকারীদের কাছে ব্যবহারের জন্য উপলব্ধ করেন৷ আপনি API পণ্যগুলিকে আপনার পণ্য লাইন হিসাবে ভাবতে পারেন।

বিশেষত, একটি API পণ্য নিম্নলিখিতগুলিকে একত্রিত করে:

• API সম্পদ সংগ্রহ (URIs)
• পরিষেবা পরিকল্পনা
• পর্যবেক্ষণ বা বিশ্লেষণের জন্য আপনার ব্যবসার জন্য নির্দিষ্ট মেটাডেটা (ঐচ্ছিক)

একটি API পণ্যে বান্ডিল করা API সংস্থানগুলি এক বা একাধিক API থেকে আসতে পারে, তাই আপনি নিম্নলিখিত চিত্রে দেখানো বিশেষ বৈশিষ্ট্য সেট তৈরি করতে সংস্থানগুলিকে মিশ্রিত করতে এবং মেলাতে পারেন৷

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

• একটি API পণ্য একটি কম অ্যাক্সেস সীমা অফার করে, যেমন একটি দর কষাকষি মূল্যের জন্য প্রতিদিন 1000 অনুরোধ। একটি দ্বিতীয় API পণ্য একই সংস্থানগুলিতে অ্যাক্সেস প্রদান করে, তবে উচ্চতর অ্যাক্সেস সীমা এবং উচ্চ মূল্য সহ।
• একটি বিনামূল্যের API পণ্য যা সম্পদগুলিতে শুধুমাত্র-পঠন অ্যাক্সেসের অফার করে। একটি দ্বিতীয় API পণ্য একটি ছোট চার্জের জন্য একই সংস্থানগুলিতে পঠন/লেখার অ্যাক্সেস প্রদান করে।

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

API পণ্যগুলি হল আপনার APIগুলিতে অনুমোদন এবং অ্যাক্সেস নিয়ন্ত্রণের কেন্দ্রীয় প্রক্রিয়া৷ Apigee-এ, API কীগুলি API-এর জন্য নয়, API পণ্যগুলির জন্য প্রভিশন করা হয়। অন্য কথায়, API কীগুলি একটি সংযুক্ত পরিষেবা পরিকল্পনা সহ সংস্থানগুলির বান্ডিলের জন্য সরবরাহ করা হয়েছে।

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

• অনুরোধকারী অ্যাপটিকে একটি নির্দিষ্ট API সংস্থান অ্যাক্সেস করার অনুমতি দেওয়া হয়েছে।
• অনুরোধকারী অ্যাপটি অনুমোদিত কোটা অতিক্রম করেনি।
• যদি সংজ্ঞায়িত করা হয়, API পণ্যে সংজ্ঞায়িত OAuth স্কোপগুলি অ্যাপের দ্বারা উপস্থাপিত অ্যাক্সেস টোকেনের সাথে যুক্ত থাকে।

মূল ধারণাগুলি বুঝুন

আপনি আপনার API পণ্য তৈরি করার আগে নিম্নলিখিত মূল ধারণা পর্যালোচনা করুন.

• API কী
• স্বয়ংক্রিয় বনাম ম্যানুয়াল কী অনুমোদন
• কোটা
• OAuth স্কোপ
• অ্যাক্সেসের মাত্রা

API কী

আপনি যখন আপনার প্রতিষ্ঠানে একটি বিকাশকারীর অ্যাপ নিবন্ধন করেন, তখন অ্যাপটিকে অবশ্যই অন্তত একটি API পণ্যের সাথে যুক্ত থাকতে হবে। এক বা একাধিক API পণ্যের সাথে একটি অ্যাপ যুক্ত করার ফলে, এজ অ্যাপটিকে একটি অনন্য ভোক্তা কী বরাদ্দ করে।

ভোক্তা কী বা অ্যাক্সেস টোকেন অনুরোধের শংসাপত্র হিসাবে কাজ করে। অ্যাপ ডেভেলপার অ্যাপের মধ্যে ভোক্তা কী এম্বেড করে, যাতে অ্যাপটি যখন এজ দ্বারা হোস্ট করা কোনো API-কে অনুরোধ করে, অ্যাপটি নিম্নলিখিত উপায়ে অনুরোধে ভোক্তা কী পাস করে:

• API যখন API কী যাচাইকরণ ব্যবহার করে, অ্যাপটিকে অবশ্যই গ্রাহক কী সরাসরি পাস করতে হবে।
• API যখন OAuth টোকেন যাচাইকরণ ব্যবহার করে, অ্যাপটিকে অবশ্যই একটি টোকেন পাস করতে হবে যা গ্রাহক কী থেকে নেওয়া হয়েছে।

API কী প্রয়োগ স্বয়ংক্রিয়ভাবে ঘটবে না। অনুরোধের শংসাপত্র হিসাবে গ্রাহক কী বা OAuth টোকেনগুলি ব্যবহার করা হোক না কেন, উপযুক্ত প্রবাহে API প্রক্সি একটি VerifyAPIKey নীতি বা একটি OAuth/VerifyAccessToken নীতি অন্তর্ভুক্ত করে আপনার API প্রক্সিগুলিতে অনুরোধের প্রমাণপত্রগুলিকে যাচাই করে৷ আপনি যদি আপনার API প্রক্সিতে একটি শংসাপত্র প্রয়োগ নীতি অন্তর্ভুক্ত না করেন, যে কোনো কলার আপনার API গুলিকে আহ্বান করতে পারে৷ আরও তথ্যের জন্য, API কী নীতি যাচাই করুন।

অনুরোধে পাস করা শংসাপত্রগুলি যাচাই করতে, এজ নিম্নলিখিত পদক্ষেপগুলি সম্পাদন করে:

• অনুরোধের সাথে পাস করা শংসাপত্রগুলি পান। OAuth টোকেন যাচাইকরণের ক্ষেত্রে, এজ যাচাই করে যে টোকেনটির মেয়াদ শেষ হয়নি, এবং তারপর টোকেন তৈরি করতে ব্যবহৃত গ্রাহক কী সন্ধান করে।
• এপিআই পণ্যের তালিকা পুনরুদ্ধার করুন যেখানে ভোক্তা কী যুক্ত করা হয়েছে।
• নিশ্চিত করুন যে বর্তমান API প্রক্সি API পণ্যে অন্তর্ভুক্ত রয়েছে এবং যদি বর্তমান সংস্থান পথ (URL পাথ) API পণ্যে সক্ষম করা থাকে।
• নিশ্চিত করুন যে ভোক্তা কী মেয়াদোত্তীর্ণ বা প্রত্যাহার করা হয়নি, পরীক্ষা করুন যে অ্যাপটি প্রত্যাহার করা হয়নি এবং অ্যাপ বিকাশকারী সক্রিয় আছে কিনা তা পরীক্ষা করুন।

উপরের সমস্ত চেক পাস হলে, শংসাপত্র যাচাই সফল হয়।

নীচের লাইন, এজ স্বয়ংক্রিয়ভাবে ভোক্তা কী তৈরি করে, কিন্তু API প্রকাশকদের উপযুক্ত নীতিগুলি ব্যবহার করে API প্রক্সিগুলিতে কী চেকিং প্রয়োগ করতে হবে।

স্বয়ংক্রিয় বনাম ম্যানুয়াল অনুমোদন

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

কোটা

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

কোটা কনফিগার করার তথ্যের জন্য, কোটা নীতি দেখুন। কোটা নীতিতে পণ্য কোটা সেটিংস ব্যবহার করার বিষয়ে তথ্যের জন্য, নিম্নলিখিত সম্প্রদায় নিবন্ধটি দেখুন একটি API পণ্যের কোটা সেটিংস কীভাবে একটি API প্রক্সিতে কোটা নীতির সাথে ইন্টারঅ্যাক্ট করে? .

OAuth স্কোপ

নিরাপত্তার একটি অতিরিক্ত স্তর হিসাবে, আপনি যেকোন OAuth স্কোপকে একটি কমা-বিভাজিত তালিকা হিসাবে সংজ্ঞায়িত করতে পারেন, যা পণ্যের মাধ্যমে প্রেরিত অ্যাক্সেস টোকেনগুলিতে উপস্থিত থাকতে হবে। আপনি যখন একটি পণ্য তৈরি করছেন, তখন আপনার প্রতিষ্ঠানের ব্যবহার করা সমস্ত সুযোগ সম্পর্কে আপনাকে সচেতন হতে হবে। একটি পণ্যে আপনি যে স্কোপগুলি যোগ করেন তা অবশ্যই বিদ্যমান স্কোপের সাথে মেলে বা পণ্যটি নিরাপদ নয়।

এজ OAuth নীতিগুলির সাথে স্কোপগুলি ব্যবহার করার বিষয়ে আরও তথ্যের জন্য, OAuth2 স্কোপের সাথে কাজ করা দেখুন।

অ্যাক্সেসের মাত্রা

একটি API পণ্য সংজ্ঞায়িত করার সময়, আপনি নিম্নলিখিত অ্যাক্সেস স্তর সেট করতে পারেন।