অ্যাপ রেজিস্টার করা ও API কী ম্যানেজ করা

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

নিম্নলিখিত বিভাগে যেভাবে বর্ণনা করা হয়েছে সেইভাবে অ্যাপ রেজিস্টার করুন এবং API কী ম্যানেজ করুন।

ভূমিকা

আপনার API কে অ্যাক্সেস করতে পারবে তা নিয়ন্ত্রণ করার প্রাথমিক পদ্ধতি হল অ্যাপ রেজিস্ট্রেশন।

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

সাধারণত, অ্যাপ ডেভেলপাররা আপনার ডেভেলপার পোর্টাল ব্যবহার করে আপনার API প্রোডাক্ট ব্যবহার করার জন্য রেজিস্টার করেন। আপনার পোর্টাল তৈরি করুন নিবন্ধে আপনার পোর্টাল তৈরি করা এবং API প্রোডাক্ট প্রকাশ করার ধাপগুলি বর্ণনা করা হয়েছে।

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

UI ও API ব্যবহার করে কীভাবে অ্যাপ রেজিস্টার করতে হয় এবং API কী ম্যানেজ করতে হয় তা নিম্নলিখিত বিভাগে বর্ণনা করা হয়েছে।

অ্যাপ পৃষ্ঠা এক্সপ্লোর করা

নিচে বর্ণনা করা পদ্ধতি অনুযায়ী অ্যাপ পৃষ্ঠা অ্যাক্সেস ও এক্সপ্লোর করুন।

Edge

Edge UI ব্যবহার করে অ্যাপ পৃষ্ঠা অ্যাক্সেস করতে:

  1. apigee.com/edge লিঙ্কে গিয়ে সাইন-ইন করুন।
  2. বাঁদিকের নেভিগেশন বারে প্রকাশ করুন > অ্যাপ বিকল্প বেছে নিন।

অ্যাপ পৃষ্ঠা দেখানো হয়।

ছবিতে হাইলাইট করা অংশ থেকে বোঝা যায় যে, অ্যাপ পৃষ্ঠা আপনাকে এগুলি করতে দেয়:

নতুন Edge UI (প্রাইভেট ক্লাউড)

নতুন Edge UI ব্যবহার করে অ্যাপ পৃষ্ঠা অ্যাক্সেস করতে:

  1. http://host:3001/edge-এ নতুন Edge UI-তে সাইন-ইন করুন, যেখানে host হল নতুন Edge UI রান করা হোস্টের IP অ্যাড্রেস বা DNS নাম।
  2. বাঁদিকের নেভিগেশন বারে প্রকাশ করুন > অ্যাপ বিকল্প বেছে নিন।

অ্যাপ পৃষ্ঠা দেখানো হয়।

নতুন Edge UI-তে অ্যাপ পৃষ্ঠা

ছবিতে হাইলাইট করা অংশ থেকে বোঝা যায় যে, অ্যাপ পৃষ্ঠা আপনাকে এগুলি করতে দেয়:

অ্যাপ রেজিস্টার করা

নিম্নলিখিত পদ্ধতিগুলির মধ্যে একটি ব্যবহার করে কোনও অ্যাপ রেজিস্টার করা যেতে পারে:

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

রেজিস্টার করা অ্যাপ এখানে যোগ করা হয়:

Edge-এ কোনও অ্যাপ রেজিস্টার করতে:

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. + অ্যাপ বিকল্পে ক্লিক করুন।
  3. অ্যাপের বিবরণ নির্দিষ্ট করুন:
    ফিল্ড বিবরণ প্রয়োজনীয়?
    নাম অ্যাপের নাম। অ্যাপ তৈরি হয়ে গেলে আপনি নাম পরিবর্তন করতে পারবেন না। ম্যানেজমেন্ট API কলে এই নাম ব্যবহার করা হয়। হ্যাঁ
    প্রদর্শন নাম Edge ম্যানেজমেন্ট UI ও ডেভেলপার পোর্টালে অ্যাপের যে নাম দেখানো হয়। না
    কোম্পানি/ডেভেলপার

    মনে রাখবেন: Apigee hybrid কোম্পানি অ্যাপে কাজ করে না; এই ফিল্ড প্রযোজ্য নয়।

    কোম্পানি বা ডেভেলপার বিকল্প বেছে নিন এবং ড্রপ-ডাউন থেকে কোনও কোম্পানি বা ডেভেলপারের নাম বেছে নিন।
    মনে রাখবেন: পারফর্ম্যান্সের কারণে, ড্রপ-ডাউনে সব কোম্পানি বা ডেভেলপারকে দেখানো হয় না। সার্চ বক্সে কোম্পানির নাম বা ডেভেলপার নাম বা ইমেল টাইপ করা শুরু করুন। এছাড়াও, অ্যাপ ডেভেলপারদের রেজিস্টার করা দেখুন।

    		 হ্যাঁ
    ইউআরএল কলব্যাক সাধারণত, ক্লায়েন্ট অ্যাপের হয়ে অনুমোদন কোড পাওয়ার জন্য নির্দিষ্ট করা অ্যাপের URL উল্লেখ করে। সব API প্রোডাক্টের জন্য এই ভ্যালু প্রয়োজন হয় না। না
    নোট অ্যাপের জন্য বর্ণনামূলক নোট। না
  4. API কীয়ের মেয়াদ শেষ হওয়ার তারিখ ও স্ট্যাটাস এবং সংশ্লিষ্ট API প্রোডাক্ট সহ ক্রেডেনশিয়াল উল্লেখ করুন।
    ক্রেডেনশিয়াল বিভাগে, বিকল্পে ক্লিক করে নিম্নলিখিত তথ্য লিখুন:
    ফিল্ড বিবরণ
    মেয়াদ শেষ মেয়াদ শেষ হওয়ার সময়সীমা বা তারিখ কনফিগার করুন অথবা API কী-এর মেয়াদ কখনও শেষ হবে না বলে সেট করুন এবং ঠিক আছে বিকল্পে ক্লিক করুন।
    প্রোডাক্ট API 'কী'-এর সাথে এক বা একাধিক API প্রোডাক্ট অ্যাসোসিয়েট করুন:
    1. প্রোডাক্ট যোগ করুন বিকল্পে ক্লিক করুন।
    2. তালিকা থেকে এক বা একাধিক API প্রোডাক্ট বেছে নিন।
    3. যোগ করুন বিকল্পে ক্লিক করুন।
    4. প্রতিটি API প্রোডাক্টের জন্য স্ট্যাটাস 'অনুমোদিত' বা 'প্রত্যাহার করা হয়েছে' হিসেবে সেট করুন।
    5. আরও API প্রোডাক্ট যোগ করতে ধাপগুলি আবার অনুসরণ করুন।
  5. কাস্টম অ্যাট্রিবিউট উল্লেখ করুন:
    1. কাস্টম অ্যাট্রিবিউট বিভাগে, আইকনে ক্লিক করুন।
    2. নাম ও ভ্যালু লিখুন।
    3. যোগ করুন অথবা যোগ করুন ও অন্য একটি শুরু করুন বিকল্পে ক্লিক করুন।
      আপনি সর্বাধিক ১৮টি কাস্টম অ্যাট্রিবিউট যোগ করতে পারবেন।
  6. তৈরি করুন বিকল্পে ক্লিক করুন।

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

ডেভেলপারের জন্য রেজিস্টার করা অ্যাপ দেখা

নির্দিষ্ট ডেভেলপারের জন্য রেজিস্টার করা অ্যাপ দেখতে, নিম্নলিখিত পদ্ধতিগুলির মধ্যে একটি ব্যবহার করুন:

অ্যাপ দেখা ও এডিট করা

কোনও অ্যাপ দেখতে ও এডিট করতে:

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. আপনি যে অ্যাপ দেখতে ও এডিট করতে চান সেটির সারিতে ক্লিক করুন।
    অ্যাপের বিবরণ দেখানো হয়।
  3. কোনও অ্যাপ এডিট করতে, এডিট করুন বিকল্পে ক্লিক করুন।
  4. নিম্নলিখিত টাস্কের মধ্যে একটি বা একাধিক টাস্ক সম্পূর্ণ করুন:
  5. সেভ করুন বিকল্পে ক্লিক করুন।

ক্রেডেনশিয়াল ম্যানেজ করা

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

আগের ছবিতে হাইলাইট করা অংশ অনুযায়ী, UI ব্যবহার করে আপনি 'ক্রেডেনশিয়াল' বিভাগে নিম্নলিখিত কাজগুলি করতে পারবেন:

ক্রেডেনশিয়াল ম্যানেজ করার জন্য API ব্যবহার করতে, নিম্নলিখিত বিভাগ দেখুন:

API key ও সিক্রেট দেখা

API key ও সিক্রেট দেখতে:

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. আপনি যে অ্যাপের API কী ও সিক্রেট দেখতে চান, সেটির সারিতে ক্লিক করুন।
  3. ক্রেডেনশিয়াল বিভাগে, আপনি যে API কী বা সিক্রেট দেখতে চান সেটির সাথে যুক্ত দেখুন বিকল্পে ক্লিক করুন।

API key অনুমোদন করা বা বাতিল করা

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

API প্রোডাক্ট ম্যানেজ করুন নিবন্ধে বর্ণিত পদ্ধতিতে, API কী অটোমেটিক অনুমোদন করার জন্য আপনি API প্রোডাক্ট কনফিগার করতে পারবেন। তবে, API প্রোডাক্টের জন্য API কী ম্যানুয়ালি অনুমোদন করতে হলে, আপনাকে ম্যানুয়ালি কী অনুমোদন করতে হবে।

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

API key অনুমোদন বা বাতিল করতে:

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. আপনি যে অ্যাপ দেখতে ও এডিট করতে চান সেটির সারিতে ক্লিক করুন।
  3. এডিট করুন বিকল্পে ক্লিক করুন।
  4. নিম্নলিখিত টাস্কগুলির মধ্যে একটি সম্পূর্ণ করুন:
    • API কী-এর সাথে যুক্ত সব API প্রোডাক্টের জন্য API কী অনুমোদন করতে বা প্রত্যাহার করতে, API কী-এর সাথে যুক্ত অনুমোদিত বা প্রত্যাহার করা হয়েছে বিকল্প বেছে নিন।
    • নির্দিষ্ট API প্রোডাক্টের জন্য API কী অনুমোদন বা বাতিল করতে, API প্রোডাক্টের স্ট্যাটাস কলামে অনুমোদিত বা বাতিল করা হয়েছে বিকল্প বেছে নিন।
  5. সেভ করুন বিকল্পে ক্লিক করুন।

অ্যাপে API প্রোডাক্ট ম্যানেজ করা

নিম্নলিখিত কাজগুলি করে আপনার অ্যাপে API প্রোডাক্ট ম্যানেজ করুন:

অ্যাপে API প্রোডাক্ট যোগ করা

কোনও অ্যাপে API প্রোডাক্ট যোগ করতে:

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

অ্যাপ থেকে API প্রোডাক্ট সরানো

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

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. আপনি যে অ্যাপ দেখতে ও এডিট করতে চান সেটির সারিতে ক্লিক করুন।
  3. এডিট করুন বিকল্পে ক্লিক করুন।
  4. API প্রোডাক্টের পাশে আইকনে ক্লিক করুন।
  5. সেভ করুন বিকল্পে ক্লিক করুন।

আপনি সরিয়ে দেওয়া প্রোডাক্ট আবার যোগ করতে পারবেন।

নতুন ক্রেডেনশিয়াল তৈরি করা হচ্ছে

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

নতুন API কী তৈরি করতে:

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. আপনি যে অ্যাপ দেখতে ও এডিট করতে চান সেটির সারিতে ক্লিক করুন।
  3. এডিট করুন বিকল্পে ক্লিক করুন।
  4. ক্রেডেনশিয়াল বিভাগে, বিকল্পে ক্লিক করুন।
  5. মেয়াদ শেষ হওয়ার তারিখ উল্লেখ করুন, API প্রোডাক্ট যোগ করুন এবং সেগুলির স্ট্যাটাস সেট করুন।
  6. ঐচ্ছিকভাবে, প্রয়োজন অনুযায়ী অন্য যেকোনও API key প্রত্যাহার করুন।
  7. সেভ করুন বিকল্পে ক্লিক করুন।

কোনও অ্যাপ অনুমোদন করা বা প্রত্যাহার করা

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

অ্যাপটি অন্য কোনও প্রতিষ্ঠানে রেজিস্টার করা থাকলে, আপনাকে অবশ্যই সেইসব প্রতিষ্ঠানে এটি বাতিল করতে হবে। প্রতিষ্ঠান। সব মেসেজ প্রসেসরকে পরিবর্তন শনাক্ত করতে কয়েক মিনিট সময় লাগতে পারে।

কোনও অ্যাপ অনুমোদন বা বাতিল করতে:

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. আপনি যে অ্যাপ দেখতে ও এডিট করতে চান সেটির সারিতে ক্লিক করুন।
  3. এডিট করুন বিকল্পে ক্লিক করুন।
  4. অ্যাপ অনুমোদন করতে বা প্রত্যাহার করতে, অ্যাপ স্ট্যাটাস ফিল্ডে যথাক্রমে অনুমোদন করুন বা প্রত্যাহার করুন বিকল্প বেছে নিন।
  5. সেভ করুন বিকল্পে ক্লিক করুন।

অ্যাপ মুছে দেওয়া

আপনি কোনও অ্যাপ মুছে দিলে, অ্যাপের সাথে যুক্ত সব ক্লায়েন্ট কী বাতিল হয়ে যায়। অনুরোধে ভুল কী ব্যবহার করলে অনুরোধটি সম্পূর্ণ হয় না।

ভবিষ্যতে কোনও ডেভেলপার অ্যাপ রিস্টোর করতে চাইলে, মুছে দেওয়ার বিকল্প হিসেবে অ্যাপের অ্যাক্সেস প্রত্যাহার করা যেতে পারে।

কোনও অ্যাপ মুছে দিতে:

  1. অ্যাপ পৃষ্ঠা অ্যাক্সেস করুন।
  2. আপনি যে অ্যাপটি মুছে ফেলতে চান সেটির সারিতে কার্সরটি রাখুন।
  3. অ্যাকশন কলামে আইকনে ক্লিক করুন।

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

API ব্যবহার করে অ্যাপ রেজিস্টার করা ও API key ম্যানেজ করা

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

এছাড়াও দেখুন আগে থেকে থাকা গ্রাহক কী ও গোপন বিষয় ইমপোর্ট করা।