পার্ট 2: একটি API কী তৈরি এবং পরীক্ষা করুন

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

রিফ্যাক্টর করা হয়েছে এবং API কীগুলির প্রয়োজন দ্বারা একটি API সুরক্ষিত করার জন্য পুনঃনির্দেশিত করা হয়েছে।

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

প্রকাশনা হল অ্যাপ ডেভেলপারদের ব্যবহারের জন্য আপনার APIগুলি উপলব্ধ করার প্রক্রিয়া৷ পাবলিশিং এপিআইগুলিকে নিম্নলিখিত কাজগুলি দ্বারা বিস্তৃতভাবে সংজ্ঞায়িত করা যেতে পারে:

  1. Apigee Edge এ API পণ্যগুলি তৈরি করুন যা আপনার APIগুলিকে বান্ডিল করে৷
  2. এজে অ্যাপ ডেভেলপারদের নিবন্ধন করুন। শুধুমাত্র একজন নিবন্ধিত অ্যাপ বিকাশকারী একটি অ্যাপ নিবন্ধন করতে পারেন।
  3. বিকাশকারীরা API পণ্যগুলি অ্যাক্সেস করতে এজে অ্যাপগুলি নিবন্ধন করে। প্রতিক্রিয়া হিসাবে, বিকাশকারী একটি API কী পায়। এখন যেহেতু বিকাশকারীর কাছে একটি API কী আছে, তারা আপনার APIগুলিতে অনুরোধ করতে পারে৷

আরও তথ্যের জন্য, প্রকাশনার ভূমিকা দেখুন।

নিম্নলিখিত সারণীটি অ্যাপ নিবন্ধন করতে এবং কী তৈরি করতে ব্যবহৃত কিছু শর্তাদি সংজ্ঞায়িত করে:

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

এই টিউটোরিয়ালের জন্য পূর্বশর্ত

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

ধাপ 1: একটি API পণ্য তৈরি করুন

  1. ব্যবস্থাপনা UI-তে, প্রকাশ করুন ট্যাবে ক্লিক করুন, তারপর পণ্যগুলিতে ক্লিক করুন।
  2. ক্লিক করুন (+) পণ্য .
  3. পণ্য যোগ করুন ডায়ালগ ক্ষেত্রে নিম্নলিখিত লিখুন বা নির্বাচন করুন:
    মাঠ মান
    নাম বিনামূল্যে API পণ্য
    প্রদর্শনের নাম বিনামূল্যে API পণ্য
    বর্ণনা বিনামূল্যে API পণ্য
    পরিবেশ পরীক্ষা
    অ্যাক্সেস শুধুমাত্র অভ্যন্তরীণ
    কী অনুমোদনের ধরন স্বয়ংক্রিয়
    (এপিআই কী তৈরি হওয়ার পরে স্বয়ংক্রিয়ভাবে অনুমোদিত হয়)
    কোটা প্রতি 1 ঘন্টায় 10টি অনুরোধ
    (প্রতি ঘন্টায় অনুরোধের সংখ্যা 10 সীমাবদ্ধ করুন)
    OAuth স্কোপ অনুমোদিত ফাঁকা ছেড়ে

    ভরাট-ইন ডায়ালগটি এইরকম হওয়া উচিত:

  4. সম্পদ বিভাগে, চয়ন করুন:
    • API প্রক্সি : ওয়েদারপিকি
    • পুনর্বিবেচনা : 1
    • সম্পদ পথ : /পূর্বাভাস**

      রিসোর্স পাথ সেই রিসোর্স ইউআরআইগুলি নির্দিষ্ট করে যা পণ্যটি একটি অ্যাপকে অ্যাক্সেস করতে দেয়৷ এই উদাহরণে, একটি অ্যাপ শুধুমাত্র /forecastrss রিসোর্সটি এই API পণ্যের মাধ্যমে ওয়েদারএপিকি প্রক্সিতে অ্যাক্সেস করতে পারে। Weatherapiproxy প্রক্সি বা অন্য কোনো প্রক্সিতে অন্য কোনো রিসোর্স অ্যাক্সেস করতে এই API পণ্যটি ব্যবহার করার চেষ্টা করা নিষিদ্ধ।

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

      উল্লেখ্য যে রিসোর্স পাথ ড্রপডাউন তালিকা নির্দিষ্ট API প্রক্সিতে সংজ্ঞায়িত সমস্ত শর্তসাপেক্ষ প্রবাহ দেখায়। একটি এপিআই প্রক্সির শর্তসাপেক্ষ প্রবাহ একটি রিসোর্স পাথের সাথে যুক্ত যুক্তি, বা প্রক্রিয়াকরণের ধাপগুলিকে সংজ্ঞায়িত করে। একটি API পণ্য সেই সম্পদ পাথগুলিতে অ্যাক্সেস নিয়ন্ত্রণ করে।
  5. রিসোর্স আমদানিতে ক্লিক করুন। রিসোর্স পাথ যোগ করা হয়, এবং ওয়েদারএপিকি API প্রক্সি স্বয়ংক্রিয়ভাবে প্রোডাক্টের জন্য API প্রক্সিতে যুক্ত হয়।
  6. Save এ ক্লিক করুন। আপনার নতুন পণ্য পণ্য পৃষ্ঠায় তালিকাভুক্ত করা হয়.

আরও জানুন:

ধাপ 2: একজন ডেভেলপার নিবন্ধন করুন

একটি API কী তৈরি করতে, আপনি একটি অ্যাপ নিবন্ধন করুন এবং এটি একটি API পণ্যের সাথে সংযুক্ত করুন৷ যাইহোক, আপনি অ্যাপটির বিকাশকারীকে প্রথমে নিবন্ধন না করে একটি অ্যাপ নিবন্ধন করতে পারবেন না।

  1. ব্যবস্থাপনা UI-তে, প্রকাশ করুন ট্যাবে ক্লিক করুন, তারপর বিকাশকারী
  2. (+) বিকাশকারীতে ক্লিক করুন।
  3. নতুন বিকাশকারী ডায়ালগে, নিম্নলিখিত মানগুলি লিখুন:
    • প্রথম নাম : জেন
    • পদবি : টিউটোরিয়াল
    • ইমেল ঠিকানা : janetutorial@example.com
    • ব্যবহারকারীর নাম : jtutorial
  4. Save এ ক্লিক করুন। নতুন বিকাশকারী বিকাশকারীদের পৃষ্ঠায় বিকাশকারীদের তালিকায় উপস্থিত হয়৷

আরও জানুন:

ধাপ 3: অ্যাপটি নিবন্ধন করুন

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

  1. API প্ল্যাটফর্ম UI-তে, প্রকাশ করুন ট্যাবে ক্লিক করুন, তারপর ডেভেলপার অ্যাপস-এ ক্লিক করুন।
  2. (+) বিকাশকারী অ্যাপে ক্লিক করুন।
  3. একটি অ্যাপ যুক্ত করুন ডায়ালগে, নিম্নলিখিত মানগুলি লিখুন:
    • প্রদর্শনের নাম : আবহাওয়া API কী অ্যাপ
    • বিকাশকারী : জেন টিউটোরিয়াল (janetutorial@example.com)
    • কলব্যাক URL : ফাঁকা ছেড়ে দিন
  4. একটি পণ্যের সাথে অ্যাপটিকে সংযুক্ত করুন:
    1. পণ্য বিভাগে, + পণ্য ক্লিক করুন।
    2. বিনামূল্যে API পণ্য নির্বাচন করুন.
    3. পরিবর্তনগুলি গ্রহণ করতে চেক মার্ক আইকনে ক্লিক করুন।
  5. Save এ ক্লিক করুন। নতুন অ্যাপটি ডেভেলপার অ্যাপস পৃষ্ঠায় অ্যাপের তালিকায় প্রদর্শিত হবে।
  6. অ্যাপের তালিকায় ওয়েদার এপিআই কী অ্যাপ নির্বাচন করুন। এটি অ্যাপের জন্য বিশদ পৃষ্ঠা খোলে।
  7. যেহেতু আপনি কী অনুমোদনের প্রকার নির্বাচন করেছেন: স্বয়ংক্রিয় যখন আপনি API পণ্য তৈরি করেন, তখন API কী স্বয়ংক্রিয়ভাবে অনুমোদিত হয় এবং আপনি তা অবিলম্বে দেখতে পারেন। (আপনি যদি অনুমোদনের ধরন: ম্যানুয়াল নির্বাচন করে থাকেন, তাহলে API কী অনুমোদন করতে আপনাকে বিনামূল্যে API পণ্যের জন্য অ্যাকশন কলামে অনুমোদন ক্লিক করতে হবে।)
  8. পণ্য বিভাগে, বিনামূল্যে API পণ্যের জন্য প্রবেশের পাশে, জেনারেট করা কীগুলি প্রদর্শন করতে ভোক্তা কী এবং ভোক্তা গোপন কলামে দেখান ক্লিক করুন৷

    কনজিউমার কী হল API কী-এর আরেকটি নাম এবং এটিই একমাত্র কী যা একটি অ্যাপকে আপনার API প্রক্সির মাধ্যমে পূর্বাভাস সংস্থান অ্যাক্সেস করতে হবে। OAuth 2.0-এর মাধ্যমে একটি API সুরক্ষিত করার জন্য উপভোক্তা গোপনীয়তা প্রয়োজন (ভোক্তা কী সহ)। দেখুন, উদাহরণস্বরূপ, OAuth 2.0: একটি নতুন API প্রক্সি কনফিগার করা

আরও জানুন:

ধাপ 4: একটি অনুরোধে API কী ব্যবহার করুন

VerifyAPIKey নীতি সঠিকভাবে কাজ করছে তা নিশ্চিত করতে, আপনাকে একটি বৈধ API কী দিয়ে API প্রক্সিতে কল করে এটি পরীক্ষা করতে হবে। আপনি একটি ব্রাউজারে API প্রক্সির জন্য অনুরোধ করতে পারেন, API প্রক্সির ট্রেস পৃষ্ঠা থেকে, Apigee কনসোল থেকে বা cURL ব্যবহার করে। অনুরোধ করার URLটি ফর্মটিতে রয়েছে:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

আপনার Apigee প্রতিষ্ঠানের নাম {org-name} এবং সঠিক apikey মান প্রতিস্থাপন করুন।

প্রতিক্রিয়াতে নিম্নলিখিত বিষয়বস্তু দেখুন:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

আপনি যদি অনুরোধ থেকে API কী বাদ দেন, বা একটি অবৈধ কী মান নির্দিষ্ট করেন, আপনি ফর্মটিতে একটি ত্রুটি প্রতিক্রিয়া পাবেন:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

ধাপ 5: পরবর্তী কোথায়?

এখন আপনি একটি ক্যোয়ারী প্যারামিটার ব্যবহার করে API-কে একটি অনুরোধ করেছেন api কী পাস করার জন্য, একটি শিরোনাম হিসাবে কী পাস করতে API-কে সংশোধন করুন।

API কীগুলির প্রয়োজন করে একটি API সুরক্ষিত করতে চালিয়ে যান।