API কী

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

API কী (Apigee Edge-এ কনজিউমার কী হিসেবে পরিচিত) হল একটি স্ট্রিং ভ্যালু যা ক্লায়েন্ট অ্যাপ আপনার API প্রক্সি সার্ভারে পাস করে। কীটি ক্লায়েন্ট অ্যাপকে অনন্যভাবে শনাক্ত করে।

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

এই সরলতা বজায় রাখতে, আপনাকে একটু সেট-আপ করতে হবে। API key কাজ করে এমন করতে, আপনাকে এগুলি করতে হবে:

• Apigee Edge API প্রোডাক্ট তৈরি করুন যা API key ব্যবহার করে আপনি রক্ষা করতে চান এমন API প্রক্সিগুলিকে একত্রিত করে।
• Apigee Edge ডেভেলপার অ্যাপ তৈরি করুন যা ক্লায়েন্ট অ্যাপ ডেভেলপারকে প্রতিনিধিত্ব করে যার অ্যাপ আপনি যাচাই করবেন।

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

• আপনার প্রক্সিগুলিতে (যেগুলি আপনি API প্রোডাক্টে অন্তর্ভুক্ত করেছেন), নীতি যোগ করুন যাতে ইনকামিং API কী বৈধ কিনা তা যাচাই করা যায়।

API 'কী' প্রয়োজন করে API সুরক্ষিত করুন টিউটোরিয়াল থেকে আপনি API 'কী' ব্যবহার করে কীভাবে API প্রক্সি অ্যাক্সেস কন্ট্রোল করবেন তা দ্রুত জানতে পারবেন।

API কী কীভাবে কাজ করে

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

উচ্চ-স্তরের ধাপ

Apigee Edge কীভাবে API কী ব্যবহার করে তা নিম্নলিখিত ধাপগুলি থেকে জানতে পারবেন। এইসব ধাপের মধ্যে OAuth নিরাপত্তা থাকার সম্ভাবনাও অন্তর্ভুক্ত, কারণ এটি প্রায়ই API কীগুলির সাথে একসাথে ব্যবহার করা হয়।

1. API key দিয়ে সুরক্ষিত করতে হবে এমন API প্রক্সি সহ একটি API প্রোডাক্ট তৈরি করুন।
2. আপনার প্রতিষ্ঠানে ডেভেলপার অ্যাপ রেজিস্টার করেন। আপনি Apigee Edge ব্যবহার করলে কনজিউমার কী ও কনজিউমার সিক্রেট তৈরি হয়।
3. অন্তত একটি API প্রোডাক্টের সাথে ডেভেলপার অ্যাপ অ্যাসোসিয়েট করুন। এটি হল সেই প্রোডাক্ট যা রিসোর্স পাথ ও API প্রক্সিগুলিকে কী অনুমোদনের সাথে যুক্ত করে।
4. রান টাইমে, ক্লায়েন্ট অ্যাপ আপনার API-তে অনুরোধ করলে, অনুরোধ করার সময় ক্লায়েন্ট অ্যাপ কনজিউমার কী পাঠায়। বাস্তবে, কনজিউমার কী হয় স্পষ্টভাবে পাস করা হতে পারে বা এটি OAuth টোকেনের মাধ্যমে পরোক্ষভাবে উল্লেখ করা হতে পারে:
   • API, API কী যাচাইকরণ ব্যবহার করলে -- যেমন, VerifyAPIKey নীতি প্রয়োগ করার মাধ্যমে -- ক্লায়েন্ট অ্যাপকে অবশ্যই স্পষ্টভাবে কনজিউমার কী পাস করতে হবে।
   • API যখন OAuth টোকেন যাচাইকরণ ব্যবহার করে -- যেমন, OAuthV2 নীতি প্রয়োগ করার মাধ্যমে -- ক্লায়েন্ট অ্যাপকে অবশ্যই এমন টোকেন পাস করতে হবে যা কনজিউমার কী থেকে উদ্ধার করা হয়েছে।
5. API প্রক্সি অনুরোধের ক্রেডেনশিয়াল যাচাই করে। এটি VerifyAPIKey নীতি বা VerifyAccessToken অপারেশন সহ OAuthV2 নীতির মাধ্যমে করা হয়। আপনি API প্রক্সিতে ক্রেডেনশিয়াল এনফোর্সমেন্ট নীতি যোগ না করলে, যেকোনও কলার আপনার API সফলভাবে ইনভোক করতে পারবেন। আরও তথ্যের জন্য, API কী যাচাইকরণ সংক্রান্ত নীতি দেখুন।

অনুরোধের ক্রেডেনশিয়াল যাচাই করা

এটি হল এক ঝলকে। বিস্তারিত তথ্য ও কোডের উদাহরণের জন্য API কী যাচাইকরণ সেট-আপ করা দেখতে ভুলবেন না।

1. আপনি OAuth টোকেন যাচাইকরণ ব্যবহার করলে -- আপনি যাচাই করার জন্য OAuth নীতি প্রয়োগ করেছেন এবং ক্লায়েন্ট অ্যাপ OAuth টোকেন পাস করেছে:
   • Apigee Edge যাচাই করে যে টোকেনের মেয়াদ শেষ হয়ে যায়নি এবং তারপরে টোকেন জেনারেট করতে ব্যবহৃত কনজিউমার কী লুক-আপ করে।
2. আপনি API কী ব্যবহার করলে -- আপনি VerifyAPIKey নীতি প্রয়োগ করেছেন এবং ক্লায়েন্ট অ্যাপ এর কনজিউমার কী পাস করেছে:
   1. Apigee Edge, কনজিউমার কী যুক্ত থাকা API প্রোডাক্টের তালিকা চেক করে।
   2. বর্তমান API Proxy, API প্রোডাক্টে অন্তর্ভুক্ত আছে কিনা এবং বর্তমান রিসোর্স পাথ (URL পাথ) API প্রোডাক্টে চালু আছে কিনা তা Edge প্রতিটি API প্রোডাক্ট চেক করে দেখে।
   3. এছাড়াও, Edge যাচাই করে যে কনজিউমার কীয়ের মেয়াদ শেষ হয়ে যায়নি বা সেটি প্রত্যাহার করা হয়নি, অ্যাপটি প্রত্যাহার করা হয়নি এবং ডেভেলপার অ্যাক্টিভ আছেন।
   4. এইসব বিষয় সত্যি হলে -- টোকেনের মেয়াদ শেষ হয়ে না গেলে (প্রযোজ্য হলে), কনজিউমার কী বৈধ ও অনুমোদিত হলে, অ্যাপ অনুমোদিত হলে, ডেভেলপার অ্যাক্টিভ থাকলে, প্রোডাক্টে প্রক্সি উপলভ্য থাকলে এবং প্রোডাক্টে রিসোর্স উপলভ্য থাকলে -- ক্রেডেনশিয়াল যাচাইকরণ সফল হয়।