API কী

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

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

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

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

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

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

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

API কী টিউটোরিয়ালের প্রয়োজনের মাধ্যমে একটি API সুরক্ষিত করুন একটি API কী সহ একটি API প্রক্সিতে অ্যাক্সেস নিয়ন্ত্রণ করতে শেখার একটি দ্রুত উপায়।

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

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

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

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

  1. API কী দিয়ে সুরক্ষিত থাকা উচিত এমন API প্রক্সিগুলি অন্তর্ভুক্ত করে এমন একটি API পণ্য তৈরি করুন
  2. আপনি আপনার প্রতিষ্ঠানে একটি বিকাশকারী অ্যাপ নিবন্ধন করুন ৷ আপনি যখন Apigee এজ করেন তখন একটি ভোক্তা কী এবং একটি ভোক্তা গোপনীয়তা তৈরি করে।
  3. ডেভেলপার অ্যাপটিকে অন্তত একটি API পণ্যের সাথে সংযুক্ত করুন । এটি সেই পণ্য যা মূল অনুমোদনের সাথে রিসোর্স পাথ এবং API প্রক্সিগুলিকে সংযুক্ত করে।
  4. রান টাইমে, যখন ক্লায়েন্ট অ্যাপ আপনার এপিআই-কে অনুরোধ করে, অনুরোধ করার সময় ক্লায়েন্ট অ্যাপ গ্রাহক কী পাঠায় । অনুশীলনে, ভোক্তা কীটি হয় স্পষ্টভাবে পাস করা যেতে পারে বা এটি একটি 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 প্রক্সি API পণ্যে অন্তর্ভুক্ত আছে কিনা এবং API পণ্যে বর্তমান রিসোর্স পাথ (url পাথ) সক্ষম করা আছে কিনা তা দেখতে Edge প্রতিটি API পণ্য পরীক্ষা করে।
    3. এজ এছাড়াও যাচাই করে যে ভোক্তা কী মেয়াদোত্তীর্ণ বা প্রত্যাহার করা হয়নি, পরীক্ষা করে যে অ্যাপটি প্রত্যাহার করা হয়নি এবং বিকাশকারী নিষ্ক্রিয় নয় তা পরীক্ষা করে।
    4. যদি এই সমস্ত জিনিসগুলি সত্য হয় -- টোকেনের মেয়াদ শেষ হয় না (যদি প্রযোজ্য হয়), ভোক্তা কী বৈধ এবং অনুমোদিত, অ্যাপটি অনুমোদিত, বিকাশকারী সক্রিয়, পণ্যে প্রক্সি উপলব্ধ, এবং সংস্থান উপলব্ধ পণ্যের উপর -- শংসাপত্র যাচাই সফল হয়।