API কী

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

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

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

এই সরলতা সমর্থন করার জন্য, আপনাকে কিছু সেটআপ করতে হবে। এপিআই কী (API key) সমর্থন করতে হলে, আপনাকে যা করতে হবে তা হলো:

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

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

  • আপনার প্রক্সিগুলোতে (যেগুলো আপনি আপনার এপিআই প্রোডাক্টে অন্তর্ভুক্ত করেছেন), আগত এপিআই কী-টি বৈধ কিনা তা যাচাই করার জন্য পলিসি যোগ করুন

"এপিআই কী আবশ্যক করে এপিআই সুরক্ষিত করুন" টিউটোরিয়ালটি হলো এপিআই কী ব্যবহার করে কীভাবে একটি এপিআই প্রক্সিতে অ্যাক্সেস নিয়ন্ত্রণ করা যায়, তা শেখার একটি দ্রুত উপায়।

এপিআই কী কীভাবে কাজ করে

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

উচ্চ-স্তরের পদক্ষেপ

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

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

অনুরোধের পরিচয়পত্র যাচাই করা হচ্ছে

এটি একটি সংক্ষিপ্ত বিবরণ। বিস্তারিত তথ্য এবং কোড উদাহরণের জন্য অবশ্যই ‘API কী ভ্যালিডেশন সেট আপ করা’ দেখুন।

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