আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশনে যান । তথ্য
একটি পরিষেবা প্রদানকারী হিসাবে, আপনি ক্লায়েন্ট অ্যাপ্লিকেশন দ্বারা ব্যবহারের জন্য API গুলি বিকাশ করেন৷ API প্রক্সি এবং API পণ্যগুলি তৈরি, কনফিগার এবং রক্ষণাবেক্ষণ করতে, আপনি UI ব্যবহার করতে পারেন বা নিম্নলিখিত বিভাগে বর্ণিত RESTful পরিষেবাগুলি অ্যাক্সেস করার জন্য APIগুলির কাছে HTTP অনুরোধ করতে পারেন৷
এজ UI ব্যবহার করুন
Apigee Edge UI হল একটি ব্রাউজার-ভিত্তিক টুল যা আপনি API প্রক্সি এবং API পণ্য তৈরি, কনফিগার এবং পরিচালনা করতে ব্যবহার করতে পারেন। কাজের একটি উপসেট শুধুমাত্র API ব্যবহার করে সম্পন্ন করা যেতে পারে, এছাড়াও.
নিচের টেবিলটি বর্ণনা করে কিভাবে এজ UI অ্যাক্সেস করতে হয়:
পণ্য | UI নাম | ইউআরএল অ্যাক্সেস করুন |
---|---|---|
প্রান্ত | এজ UI | এজ UI অ্যাক্সেস করতে, নিম্নলিখিত URLটি ব্যবহার করুন: https://apigee.com/edge এজ UI ব্যবহার করার টিউটোরিয়ালের জন্য, আপনার প্রথম API প্রক্সি তৈরি করুন দেখুন। |
প্রাইভেট ক্লাউডের জন্য এজ | ক্লাসিক এজ UI | প্রাইভেট ক্লাউডের জন্য এজ এর জন্য এজ UI অ্যাক্সেস করতে, নিম্নলিখিত URLটি ব্যবহার করুন: http://ms-ip:9000 যেখানে ms-ip হল ম্যানেজমেন্ট সার্ভার নোডের IP ঠিকানা বা DNS নাম। |
এজ UI ব্যবহার করে, আপনি করতে পারেন:
- কোড সম্পাদনা করে API প্রক্সি তৈরি করুন এবং আপনার প্রক্সিগুলির মাধ্যমে অনুরোধের প্রবাহ ট্রেস করুন৷
- ক্লায়েন্ট অনুরোধের এক্সপোজার জন্য প্রক্সি বান্ডিল যে API পণ্য তৈরি করুন.
- বিকাশকারী এবং বিকাশকারী অ্যাপগুলি পরিচালনা করুন।
- আপনার পরীক্ষা এবং উত্পাদন পরিবেশ কনফিগার করুন।
- JavaScript এবং Node.js অ্যাপ্লিকেশন প্রয়োগ করুন।
নিম্নলিখিত চিত্রটি UI-তে API প্রক্সি সম্পাদক দেখায় যা আপনি একটি API প্রক্সি তৈরি এবং কনফিগার করতে ব্যবহার করতে পারেন:
এজ এপিআই ব্যবহার করুন
আপনি আপনার API সংস্থানগুলি পরিচালনা করতে এজ API ব্যবহার করতে পারেন। এপিআইগুলি নিম্ন-স্তরের ক্ষমতাগুলিতে অ্যাক্সেস সরবরাহ করে যা UI দ্বারা প্রকাশিত হয় না।
API এন্ডপয়েন্টগুলি প্রায়ই কনফিগারেশন তথ্য ধারণকারী ডেটা নেয় এবং সেগুলি অ্যাক্সেস করার জন্য আপনাকে প্রমাণীকরণ তথ্য, যেমন ব্যবহারকারীর নাম এবং পাসওয়ার্ড পাস করতে হবে। RESTful নীতিগুলি অনুসরণ করে, আপনি যেকোন API সংস্থানে HTTP GET
, POST
, PUT
, এবং DELETE
পদ্ধতিতে কল করতে পারেন৷
Apigee Edge API-এর সম্পূর্ণ তালিকার জন্য, Apigee Edge API রেফারেন্স দেখুন।
এজ এপিআই বেস পাথ বুঝুন
API অনুরোধগুলিতে আপনি যে পথটি ব্যবহার করবেন তা নিম্নলিখিতগুলিকে সংযুক্ত করে:
- একটি বেস পাথ যা আপনার প্রতিষ্ঠানের নাম অন্তর্ভুক্ত করে। যেমন:
https://api.enterprise.apigee.com/v1/organizations/ org_name
- একটি এন্ডপয়েন্ট যা আপনি যে এজ রিসোর্সটি অ্যাক্সেস করছেন তার দিকে নির্দেশ করে।
উদাহরণ স্বরূপ, যদি আপনার প্রতিষ্ঠানের নাম হয় apibuilders
, তাহলে আপনি API-তে করা প্রতিটি কল নিম্নলিখিত বেস পাথ ব্যবহার করবে:
https://api.enterprise.apigee.com/v1/organizations/apibuilders
আপনার প্রতিষ্ঠানে API প্রক্সিগুলির একটি তালিকা পুনরুদ্ধার করতে, আপনি GET এ কল করবেন:
https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis
অনেক সম্পদ পরিবেশ দ্বারা স্কোপ করা হয়. ডিফল্টরূপে দুটি পরিবেশ প্রদান করা হয়: পরীক্ষা এবং প্রোড। উদাহরণস্বরূপ, ক্যাশে পরিবেশের দ্বারা স্কোপ করা হয়। "mycache" নামক একটি ভাগ করা ক্যাশে ডিফল্টরূপে প্রতিটি পরিবেশে অন্তর্ভুক্ত করা হয়।
আপনি ক্যাশে রিসোর্সে GET কল করে ক্যাশে তালিকা করতে পারেন:
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches
প্রবেশাধিকার প্রমাণীকরণ
আপনি APIs কল করার সময় আপনাকে অবশ্যই API সার্ভারে নিজেকে প্রমাণী করতে হবে। আপনি নিম্নলিখিত উপায়ে এটি করতে পারেন:
- OAuth2
- SAML
- মৌলিক প্রমাণীকরণ (প্রস্তাবিত নয়)
এছাড়াও, Apigee সুপারিশ করে যে আপনি দ্বি-গুণক প্রমাণীকরণ ব্যবহার করুন, যেমন আপনার Apigee অ্যাকাউন্টের জন্য দ্বি-গুণক প্রমাণীকরণ সক্ষম করুন- এ বর্ণিত হয়েছে।
এজ এপিআই সীমা
প্রতিটি সংস্থা নিম্নলিখিত এজ API কল রেটগুলিতে সীমাবদ্ধ:
- পেইড প্ল্যানে প্রতিষ্ঠানের জন্য প্রতি মিনিটে 10,000 কল
- ট্রায়াল সংস্থার জন্য প্রতি মিনিটে 600 কল
HTTP স্ট্যাটাস কোড 401
এবং 403
এই সীমার বিপরীতে গণনা করা হয় না। এই সীমা অতিক্রম করে যে কোনো কল একটি 429 Too Many Requests
স্ট্যাটাস কোড প্রদান করে।
এজ এপিআই-এর সাথে কাজ করার জন্য টিপস
এই বিভাগটি এমন কিছু কৌশল বর্ণনা করে যা এজ এপিআইগুলির সাথে কাজ করা সহজ করে তোলে।
সংক্ষেপে অনুরোধের URL
আপনি যখন এজ এপিআই-তে আপনার অনুরোধের 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
কার্ল কমান্ড চালান
API এ অনুরোধ করতে একটি HTTP ক্লায়েন্ট ব্যবহার করুন। ডকুমেন্টেশনের অনেক উদাহরণ curl
ব্যবহার করে নমুনা API অনুরোধ প্রদান করে, একটি বহুল ব্যবহৃত HTTP ক্লায়েন্ট। আপনি যদি curl
ইনস্টল করতে চান তবে আপনি এটি http://curl.haxx.se থেকে ডাউনলোড করতে পারেন।
এপিআই-তে কলগুলি প্রতিক্রিয়াগুলিতে জিজিপ কম্প্রেশন সমর্থন করে। আপনি যদি আপনার API কলগুলিতে 'Accept-Encoding: gzip, deflate'
সেট করেন, তাহলে 1024 বাইটের বেশি যেকোনো প্রতিক্রিয়া gzip ফর্ম্যাটে ফেরত দেওয়া হবে।
XML এবং JSON অনুরোধ এবং প্রতিক্রিয়া ফর্ম্যাটিং
এজ এপিআই ডিফল্টরূপে 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-এ পেলোড পোস্ট করার সময় বা পুটিং করার সময়, 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 ব্যবহার করা প্রতিটি সংস্থার অন্তত দুটি পরিবেশ থাকে তারা APIs বিকাশ, পরীক্ষা এবং স্থাপন করতে ব্যবহার করতে পারে: "পরীক্ষা" এবং "প্রোড"। আপনার APIগুলিকে সর্বজনীনভাবে উপলব্ধ করার আগে বিকাশ এবং পরীক্ষা করতে "পরীক্ষা" পরিবেশ ব্যবহার করুন৷ শুধুমাত্র আপনার অভ্যন্তরীণ বিকাশকারীরা পরীক্ষার পরিবেশে নিয়োজিত APIগুলি অ্যাক্সেস করতে পারে৷ অ্যাপ বিকাশকারীদের কাছে সর্বজনীনভাবে উপলব্ধ করতে আপনার APIগুলিকে "প্রোড" পরিবেশে স্থাপন করুন৷
ডিবাগিং এবং টেস্টিং
Apigee একটি ট্রেস টুল প্রদান করে যা আপনাকে এন্ড-টু-এন্ড রিকোয়েস্ট এবং রেসপন্স ফ্লো ডিবাগ করতে দেয়। ট্রেস ফলাফল অনুরোধ এবং প্রতিক্রিয়া শিরোনাম এবং পেলোড, নীতি নির্বাহ, পরিবর্তনশীল মান, এবং প্রবাহের সময় ঘটেছে এমন কোনো ত্রুটি প্রদর্শন করে।
সমস্যা সমাধানে ব্যবহারের জন্য মূল ডেটা পয়েন্ট:
- টাইমস্ট্যাম্প : প্রতিটি ধাপ কার্যকর করতে কতক্ষণ লাগে তা দেখতে টাইমস্ট্যাম্প ব্যবহার করুন। টাইমস্ট্যাম্প তুলনা করা আপনাকে সেই নীতিগুলিকে আলাদা করতে সাহায্য করে যেগুলি কার্যকর করতে সবচেয়ে বেশি সময় নেয় যা আপনার API কলগুলিকে ধীর করে দিচ্ছে৷
- বেস পাথ : বেস পাথ যাচাই করে, আপনি নিশ্চিত করতে পারেন যে একটি নীতি বার্তাটিকে সঠিক সার্ভারে রাউটিং করছে।
- নীতি বাস্তবায়নের ফলাফল : এই ফলাফলগুলি আপনাকে দেখতে দেয় যে বার্তাটি প্রত্যাশিতভাবে পরিবর্তিত হচ্ছে কিনা, যেমন বার্তাটি XML থেকে JSON-এ রূপান্তরিত হচ্ছে কিনা বা বার্তাটি ক্যাশে করা হচ্ছে কিনা।
নিম্নলিখিত চিত্রটি ট্রেস ফলাফল দেখায়:
প্রতিটি ট্রেস সেশন নিম্নলিখিত প্রধান ধাপে বিভক্ত করা হয়:
- ক্লায়েন্টের কাছ থেকে প্রাপ্ত আসল অনুরোধ : ক্লায়েন্ট অ্যাপ, হেডার, বডি ডেটা এবং ক্যোয়ারী প্যারামিটার থেকে অনুরোধের ক্রিয়া এবং URI পাথ প্রদর্শন করে।
- আপনার ব্যাকএন্ড পরিষেবাতে পাঠানো অনুরোধ : API প্রক্সি দ্বারা ব্যাকএন্ড পরিষেবাতে পাঠানো অনুরোধ বার্তা প্রদর্শন করে৷
- ব্যাকএন্ড পরিষেবা দ্বারা প্রত্যাবর্তিত প্রতিক্রিয়া : ব্যাকএন্ড পরিষেবা দ্বারা ফিরে আসা প্রতিক্রিয়া শিরোনাম এবং পেলোড প্রদর্শন করে৷
- ক্লায়েন্টের কাছে পাঠানো চূড়ান্ত প্রতিক্রিয়া: প্রতিক্রিয়া প্রবাহ কার্যকর হওয়ার পরে প্রতিক্রিয়া বার্তা অনুরোধকারী ক্লায়েন্ট অ্যাপে ফিরে আসে।