ডেভেলপমেন্ট টুলস

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

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

Edge UI ব্যবহার করুন

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

নিচের সারণিতে এজ UI অ্যাক্সেস করার পদ্ধতি বর্ণনা করা হয়েছে:

পণ্য UI নাম URL অ্যাক্সেস করুন
প্রান্ত এজ ইউআই

Edge UI অ্যাক্সেস করতে, নিম্নলিখিত URL-টি ব্যবহার করুন:

https://apigee.com/edge

Edge UI ব্যবহারের টিউটোরিয়ালের জন্য, আপনার প্রথম API প্রক্সি তৈরি করুন দেখুন।

প্রাইভেট ক্লাউডের জন্য এজ ক্লাসিক এজ UI-তে

Edge for Private Cloud-এর Edge UI অ্যাক্সেস করতে, নিম্নলিখিত URL-টি ব্যবহার করুন:

http://ms-ip:9000

যেখানে ms-ip হলো ম্যানেজমেন্ট সার্ভার নোডের আইপি অ্যাড্রেস বা ডিএনএস নেম।

Edge UI ব্যবহার করে, আপনি যা করতে পারেন:

  • কোড সম্পাদনা করে এবং আপনার প্রক্সিগুলোর মাধ্যমে অনুরোধ প্রবাহ অনুসরণ করে এপিআই প্রক্সি তৈরি করুন।
  • এমন এপিআই পণ্য তৈরি করুন যা ক্লায়েন্টের অনুরোধের কাছে পৌঁছানোর জন্য প্রক্সি অন্তর্ভুক্ত করে।
  • ডেভেলপার এবং ডেভেলপার অ্যাপগুলো পরিচালনা করুন।
  • আপনার টেস্ট এবং প্রোডাকশন এনভায়রনমেন্ট কনফিগার করুন।
  • জাভাস্ক্রিপ্ট এবং নোড.জেএস অ্যাপ্লিকেশন তৈরি করুন।

নিচের ছবিতে UI-তে থাকা API প্রক্সি এডিটরটি দেখানো হয়েছে, যা ব্যবহার করে আপনি একটি API প্রক্সি তৈরি ও কনফিগার করতে পারবেন:

Edge UI-এর API প্রক্সি এডিটরে Develop ট্যাবটি নির্বাচিত অবস্থায় দেখাচ্ছে।

Edge API ব্যবহার করুন

আপনি আপনার এপিআই রিসোর্সগুলো পরিচালনা করতে এজ এপিআই ব্যবহার করতে পারেন। এই এপিআইগুলো এমন সব নিম্ন-স্তরের সক্ষমতা ব্যবহারের সুযোগও দেয়, যা ইউআই-এর মাধ্যমে প্রকাশ করা হয় না।

এপিআই এন্ডপয়েন্টগুলো প্রায়শই কনফিগারেশন তথ্য সম্বলিত ডেটা গ্রহণ করে এবং সেগুলোতে অ্যাক্সেস করার জন্য আপনাকে ইউজারনেম ও পাসওয়ার্ডের মতো অথেনটিকেশন তথ্য প্রদান করতে হয়। RESTful নীতি অনুসরণ করে, আপনি যেকোনো এপিআই রিসোর্সের উপর HTTP GET , POST , PUT এবং DELETE মেথড কল করতে পারেন।

Apigee Edge API-গুলির সম্পূর্ণ তালিকার জন্য, Apigee Edge API Reference দেখুন।

Edge API বেস পাথ বুঝুন

এপিআই অনুরোধে আপনি যে পাথটি ব্যবহার করবেন, তা নিম্নলিখিত বিষয়গুলো সংযুক্ত করে গঠিত হয়:

  • একটি বেস পাথ যাতে আপনার প্রতিষ্ঠানের নাম অন্তর্ভুক্ত থাকে। উদাহরণস্বরূপ: https://api.enterprise.apigee.com/v1/organizations/ org_name
  • একটি এন্ডপয়েন্ট যা আপনার অ্যাক্সেস করা এজ রিসোর্সটিকে নির্দেশ করে।

উদাহরণস্বরূপ, যদি আপনার প্রতিষ্ঠানের নাম apibuilders হয়, তাহলে API-তে আপনার করা প্রতিটি কল নিম্নলিখিত বেস পাথটি ব্যবহার করবে:

https://api.enterprise.apigee.com/v1/organizations/apibuilders

আপনার প্রতিষ্ঠানে থাকা এপিআই প্রক্সিগুলোর তালিকা পেতে, আপনাকে GET কল করতে হবে:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

অনেক রিসোর্স এনভায়রনমেন্ট দ্বারা নির্ধারিত হয়। ডিফল্টরূপে দুটি এনভায়রনমেন্ট প্রদান করা হয়: test এবং prod। উদাহরণস্বরূপ, ক্যাশগুলোও এনভায়রনমেন্ট দ্বারা নির্ধারিত হয়। 'mycache' নামক একটি শেয়ার্ড ক্যাশ ডিফল্টরূপে প্রতিটি এনভায়রনমেন্টে অন্তর্ভুক্ত থাকে।

নিম্নলিখিতভাবে ক্যাশ রিসোর্সে GET কল করে আপনি ক্যাশগুলির তালিকা দেখতে পারেন:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

অ্যাক্সেস প্রমাণীকরণ করুন

এপিআই কল করার সময় আপনাকে অবশ্যই এপিআই সার্ভারে নিজের পরিচয় প্রমাণ করতে হবে। আপনি নিম্নলিখিত উপায়গুলির মধ্যে যেকোনো একটির মাধ্যমে এটি করতে পারেন:

এছাড়াও, Apigee আপনাকে টু-ফ্যাক্টর অথেন্টিকেশন ব্যবহার করার পরামর্শ দেয়, যেমনটি "আপনার Apigee অ্যাকাউন্টের জন্য টু-ফ্যাক্টর অথেন্টিকেশন সক্ষম করুন" অংশে বর্ণনা করা হয়েছে।

এজ এপিআই সীমাবদ্ধতা

প্রতিটি সংস্থা নিম্নলিখিত Edge API কল রেটগুলিতে সীমাবদ্ধ:

  • পেইড প্ল্যানে থাকা সংস্থাগুলির জন্য প্রতি মিনিটে ১০,০০০ কল
  • পরীক্ষামূলক সংস্থাগুলির জন্য প্রতি মিনিটে ৬০০টি কল

HTTP স্ট্যাটাস কোড 401 এবং 403 এই সীমার মধ্যে গণনা করা হয় না। যে কোনো কল এই সীমা অতিক্রম করলে 429 Too Many Requests স্ট্যাটাস কোড ফেরত আসে।

Edge API নিয়ে কাজ করার জন্য কিছু পরামর্শ

এই অংশে এমন কিছু কৌশল বর্ণনা করা হয়েছে যা এজ এপিআই (Edge APIs) নিয়ে কাজ করাকে আরও সহজ করে তোলে।

অনুরোধ URL সংক্ষিপ্ত করা

Edge API-এর জন্য আপনার রিকোয়েস্ট URL তৈরি করার সময়, আপনি নিম্নলিখিত সংক্ষিপ্ত রূপগুলো ব্যবহার করতে পারেন:

  • /e = /environments
  • /o = /organizations
  • /r = /revisions

আপনি যদি সংক্ষিপ্ত রূপ ব্যবহার করেন, তবে আপনাকে অবশ্যই তা সামঞ্জস্যপূর্ণভাবে ব্যবহার করতে হবে। অর্থাৎ, উপরে উল্লিখিত এবং নিম্নলিখিত উদাহরণে প্রদর্শিত পদ্ধতি অনুযায়ী পাথের সমস্ত উপাদানকে সংক্ষিপ্ত করুন, অথবা কোনোটিই সংক্ষিপ্ত করবেন না। একই পাথে পূর্ণ এবং সংক্ষিপ্ত উভয় উপাদান ব্যবহার করলে একটি ত্রুটি দেখা দেবে।

উদাহরণস্বরূপ:

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

curl কমান্ডগুলো চালান

এপিআই-তে অনুরোধ পাঠানোর জন্য একটি এইচটিটিপি ক্লায়েন্ট ব্যবহার করুন। ডকুমেন্টেশনের অনেক উদাহরণে বহুল ব্যবহৃত এইচটিটিপি ক্লায়েন্ট curl ব্যবহার করে নমুনা এপিআই অনুরোধ দেওয়া আছে। আপনার যদি curl ইনস্টল করার প্রয়োজন হয়, তবে আপনি এটি http://curl.haxx.se থেকে ডাউনলোড করতে পারেন।

এপিআই-তে করা কলগুলোর রেসপন্সে gzip কম্প্রেশন সাপোর্ট করে। আপনি যদি আপনার এপিআই কলে 'Accept-Encoding: gzip, deflate' সেট করেন, তাহলে ১০২৪ বাইটের চেয়ে বড় যেকোনো রেসপন্স gzip ফরম্যাটে ফেরত দেওয়া হবে।

XML এবং JSON অনুরোধ এবং প্রতিক্রিয়া ফরম্যাট করা

Edge API ডিফল্টরূপে JSON ফরম্যাটে ডেটা ফেরত দেয়। অনেক অনুরোধের ক্ষেত্রে, আপনি এর পরিবর্তে XML ফরম্যাটে প্রতিক্রিয়া পেতে পারেন। এটি করার জন্য, Accept রিকোয়েস্ট হেডারটি application/xml এ সেট করুন, যেমনটি নিম্নলিখিত উদাহরণে দেখানো হয়েছে:

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

প্রতিক্রিয়াটি নিম্নলিখিতের মতো হওয়া উচিত:

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

উল্লেখ্য যে, এই উদাহরণটিতে রেসপন্সকে xmllint মাধ্যমে পাইপ করে ফলাফল প্রদর্শনের জন্য prettyprint ব্যবহার করা হয়েছে।

acurl ইউটিলিটি Accept হেডার সমর্থন করে না। ফলে, acurl দিয়ে আপনি শুধুমাত্র JSON-ফরম্যাটের রেসপন্স পেতে পারেন।

JSON রেসপন্সের জন্য prettyprint ব্যবহার করতে, আপনি json.tool পাইথন লাইব্রেরিটি ব্যবহার করতে পারেন: 

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

নিম্নলিখিতটি প্রতিক্রিয়ার একটি উদাহরণ: 

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

XML-এর জন্য আপনি xmllint ব্যবহার করতে পারেন: 

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

XML-এ পেলোড POST বা PUT করার সময়, Content-type HTTP হেডারটি ব্যবহার করুন: 

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

স্থাপন পরিবেশ

Apigee Edge ব্যবহারকারী প্রতিটি প্রতিষ্ঠানের ডিফল্টরূপে এপিআই (API) তৈরি, পরীক্ষা এবং স্থাপন করার জন্য কমপক্ষে দুটি এনভায়রনমেন্ট থাকে: "test" এবং "prod"। আপনার এপিআইগুলো সর্বজনীনভাবে উপলব্ধ করার আগে সেগুলোর উন্নয়ন ও পরীক্ষার জন্য "test" এনভায়রনমেন্ট ব্যবহার করুন। শুধুমাত্র আপনার অভ্যন্তরীণ ডেভেলপাররাই টেস্ট এনভায়রনমেন্টে স্থাপন করা এপিআইগুলো অ্যাক্সেস করতে পারবেন। অ্যাপ ডেভেলপারদের কাছে এপিআইগুলো সর্বজনীনভাবে উপলব্ধ করতে সেগুলোকে "prod" এনভায়রনমেন্টে স্থাপন করুন।

ডিবাগিং এবং টেস্টিং

Apigee একটি ট্রেস টুল প্রদান করে যা আপনাকে শুরু থেকে শেষ পর্যন্ত অনুরোধ এবং প্রতিক্রিয়া প্রবাহ ডিবাগ করতে দেয়। ট্রেসের ফলাফলে অনুরোধ ও প্রতিক্রিয়ার হেডার এবং পেলোড, পলিসি এক্সিকিউশন, ভেরিয়েবলের মান এবং প্রবাহ চলাকালীন ঘটে যাওয়া যেকোনো ত্রুটি প্রদর্শিত হয়।

সমস্যা সমাধানে ব্যবহারের জন্য গুরুত্বপূর্ণ তথ্যবিন্দু:

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

নিম্নলিখিত চিত্রে ট্রেস ফলাফল দেখানো হয়েছে:

Edge UI-এর API প্রক্সি এডিটরে ট্রেস ট্যাবটি নির্বাচিত অবস্থায় দেখাচ্ছে।

প্রতিটি ট্রেস সেশন নিম্নলিখিত প্রধান ধাপগুলিতে বিভক্ত:

  • ক্লায়েন্টের কাছ থেকে প্রাপ্ত মূল অনুরোধ : ক্লায়েন্ট অ্যাপ থেকে আসা অনুরোধের ভার্ব ও ইউআরআই পাথ, হেডার, বডি ডেটা এবং কোয়েরি প্যারামিটার প্রদর্শন করে।
  • আপনার ব্যাকএন্ড পরিষেবাতে অনুরোধ পাঠানো হয়েছে : এপিআই প্রক্সি দ্বারা ব্যাকএন্ড পরিষেবাতে পাঠানো অনুরোধ বার্তাটি প্রদর্শন করে।
  • ব্যাকএন্ড পরিষেবা দ্বারা ফেরত দেওয়া প্রতিক্রিয়া : ব্যাকএন্ড পরিষেবা দ্বারা ফেরত দেওয়া প্রতিক্রিয়া হেডার এবং পেলোড প্রদর্শন করে।
  • ক্লায়েন্টের কাছে পাঠানো চূড়ান্ত প্রতিক্রিয়া: প্রতিক্রিয়া প্রবাহটি কার্যকর হওয়ার পর অনুরোধকারী ক্লায়েন্ট অ্যাপে যে প্রতিক্রিয়া বার্তাটি ফেরত পাঠানো হয়।