আপনার API প্রকাশ করুন

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

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

API প্রকাশনার ওভারভিউ

আপনার পোর্টালে API প্রকাশ করার প্রক্রিয়াটি একটি দ্বি-পদক্ষেপ প্রক্রিয়া:

1. আপনি আপনার পোর্টালে প্রকাশ করতে চান এমন API পণ্য নির্বাচন করুন।
2. আপনার OpenAPI ডকুমেন্ট বা GraphQL স্কিমার একটি স্ন্যাপশট থেকে API রেফারেন্স ডকুমেন্টেশন রেন্ডার করুন যাতে অ্যাপ ডেভেলপারদের আপনার API সম্পর্কে জানতে সক্ষম করে। (স্ন্যাপশট সম্পর্কে আরও তথ্যের জন্য, একটি স্ন্যাপশট কী? )

পোর্টালে কি প্রকাশ করা হয়?

SmartDocs (OpenAPI)

যখন আপনি একটি OpenAPI নথি ব্যবহার করে একটি API প্রকাশ করেন, SmartDocs API রেফারেন্স ডকুমেন্টেশন আপনার পোর্টালে যোগ করা হয়।

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

ক্লিক করুন এই API প্যানেলটি প্রসারিত করতে। প্রসারিত প্যানেল আপনাকে বিভিন্ন ফরম্যাটে যেমন HTTP, Python, Node.js এবং আরও অনেক কিছুতে কার্ল কল এবং কোডের নমুনা দেখতে সক্ষম করে, যেমন নীচে দেখানো হয়েছে।

গ্রাফকিউএল এক্সপ্লোরার

আপনি যখন GraphQL স্কিমা ব্যবহার করে একটি API প্রকাশ করেন, তখন GraphQL এক্সপ্লোরার আপনার পোর্টালে যোগ করা হয়। গ্রাফকিউএল এক্সপ্লোরার হল একটি ইন্টারেক্টিভ খেলার মাঠ যা আপনার এপিআই-এর বিরুদ্ধে প্রশ্ন চালানোর জন্য। এক্সপ্লোরারটি GraphiQL এর উপর ভিত্তি করে তৈরি করা হয়েছে, যা GraphQL ফাউন্ডেশন দ্বারা তৈরি GraphQL IDE-এর একটি রেফারেন্স বাস্তবায়ন।

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

GraphQL সম্পর্কে আরও তথ্যের জন্য, graphql.org দেখুন।

একটি স্ন্যাপশট কি?

প্রতিটি OpenAPI বা GraphQL নথি একটি API-এর জীবনচক্র জুড়ে সত্যের উৎস হিসেবে কাজ করে। একই নথি API জীবনচক্রের প্রতিটি পর্যায়ে ব্যবহার করা হয়, বিকাশ থেকে প্রকাশনা থেকে পর্যবেক্ষণ পর্যন্ত। যখন আপনি একটি নথি পরিবর্তন করেন, তখন আপনাকে অন্যান্য জীবনচক্রের পর্যায়গুলির মাধ্যমে পরিবর্তনগুলি আপনার API-তে কী প্রভাব ফেলে তা সম্পর্কে সচেতন হতে হবে, যেমন আমি একটি নথি সংশোধন করলে কী হবে?

আপনি যখন আপনার API প্রকাশ করেন, তখন আপনি API রেফারেন্স ডকুমেন্টেশন রেন্ডার করতে OpenAPI বা GraphQL নথির একটি স্ন্যাপশট নেন। সেই স্ন্যাপশটটি নথির একটি নির্দিষ্ট সংস্করণ উপস্থাপন করে। আপনি যদি দস্তাবেজটি পরিবর্তন করেন, তাহলে আপনি API রেফারেন্স ডকুমেন্টেশনে সর্বশেষ পরিবর্তনগুলি প্রতিফলিত করার জন্য নথিটির অন্য একটি স্ন্যাপশট নেওয়ার সিদ্ধান্ত নিতে পারেন।

কলব্যাক URL সম্পর্কে

যদি আপনার অ্যাপ্লিকেশানগুলির একটি কলব্যাক URL এর প্রয়োজন হয়, যেমন OAuth 2.0 অনুমোদন কোড অনুদানের ধরন ব্যবহার করার সময় (প্রায়শই "থ্রি-লেগড OAuth" হিসাবে উল্লেখ করা হয়), আপনি ডেভেলপারদের তাদের অ্যাপ নিবন্ধন করার সময় একটি কলব্যাক URL নির্দিষ্ট করতে বলতে পারেন৷ কলব্যাক URL সাধারণত একটি অ্যাপের URL নির্দিষ্ট করে যা ক্লায়েন্ট অ্যাপের পক্ষ থেকে একটি অনুমোদন কোড পাওয়ার জন্য মনোনীত হয়। আরও তথ্যের জন্য, অনুমোদন কোড অনুদানের ধরন বাস্তবায়ন দেখুন।

আপনার পোর্টালে একটি API যোগ করার সময় অ্যাপ রেজিস্ট্রেশনের সময় একটি কলব্যাক URL এর প্রয়োজন হবে কি না তা আপনি কনফিগার করতে পারেন৷ আপনি যে কোনো সময় এই সেটিংটি সংশোধন করতে পারেন, যেমন একটি API-এর জন্য কলব্যাক URL পরিচালনা করুন -এ বর্ণিত আছে।

একটি অ্যাপ রেজিস্টার করার সময়, ডেভেলপারদের অবশ্যই সমস্ত API-এর জন্য একটি কলব্যাক URL লিখতে হবে, যা রেজিস্টার অ্যাপে বর্ণিত।

"এই API ব্যবহার করে দেখুন" সমর্থন করার জন্য আপনার API প্রক্সি কনফিগার করুন

একটি OpenAPI নথি ব্যবহার করে আপনার APIগুলি প্রকাশ করার আগে, আপনাকে SmartDocs API রেফারেন্স ডকুমেন্টেশনের এই API প্যানেলে অনুরোধগুলিকে সমর্থন করার জন্য আপনার API প্রক্সি কনফিগার করতে হবে, নিম্নরূপ:

• ক্লায়েন্ট-সাইড ক্রস-অরিজিন অনুরোধগুলি প্রয়োগ করতে আপনার API প্রক্সিগুলিতে CORS সমর্থন যোগ করুন

  CORS হল একটি স্ট্যান্ডার্ড মেকানিজম যা জাভাস্ক্রিপ্ট XMLHttpRequest (XHR) কলগুলিকে একটি ওয়েব পৃষ্ঠায় নির্বাহিত অ-অরিজিন ডোমেন থেকে রিসোর্সের সাথে ইন্টারঅ্যাক্ট করার অনুমতি দেয়। CORS হল " একই-অরিজিন নীতি " এর একটি সাধারণভাবে প্রয়োগ করা সমাধান যা সমস্ত ব্রাউজার দ্বারা প্রয়োগ করা হয়।

• আপনি যদি মৌলিক প্রমাণীকরণ বা OAuth2 ব্যবহার করেন তবে আপনার API প্রক্সি কনফিগারেশন আপডেট করুন

নিম্নলিখিত সারণীটি প্রমাণীকরণ অ্যাক্সেসের উপর ভিত্তি করে SmartDocs API রেফারেন্স ডকুমেন্টেশনে এই API প্যানেলটি ব্যবহার করে দেখুন সমর্থন করার জন্য API প্রক্সি কনফিগারেশন প্রয়োজনীয়তাগুলিকে সংক্ষিপ্ত করে৷

API ক্যাটালগ অন্বেষণ করুন

API ক্যাটালগ দেখতে: 1. প্রকাশ > পোর্টাল নির্বাচন করুন এবং আপনার পোর্টাল নির্বাচন করুন। 2. পোর্টাল হোম পেজে API ক্যাটালগে ক্লিক করুন। বিকল্পভাবে, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনুতে API ক্যাটালগ নির্বাচন করতে পারেন।

API ক্যাটালগের APIs ট্যাব আপনার পোর্টালে যোগ করা APIগুলির একটি তালিকা প্রদর্শন করে।

আগের চিত্রে যেমন হাইলাইট করা হয়েছে, APIs ট্যাব আপনাকে এতে সক্ষম করে:

• আপনার পোর্টালে উপলব্ধ API-এর বিশদ বিবরণ দেখুন
• আপনার পোর্টালে একটি API যোগ করুন
• নিম্নলিখিত এক বা একাধিক কাজ সম্পাদন করে আপনার পোর্টালে একটি API সম্পাদনা করুন:
  • API রেফারেন্স ডকুমেন্টেশন আপডেট করতে একটি API পণ্যের সাথে যুক্ত একটি নথির স্ন্যাপশট পরিচালনা করুন৷
  • আপনার পোর্টালে একটি API প্রকাশ বা অপ্রকাশিত করুন
  • আপনার পোর্টালে একটি API এর দৃশ্যমানতা পরিচালনা করুন :
  • একটি API-এর জন্য কলব্যাক URL পরিচালনা করুন
  • একটি API কার্ডের জন্য ছবি পরিচালনা করুন
  • বিভাগ ব্যবহার করে একটি API ট্যাগ করুন
  • API শিরোনাম এবং বিবরণ সম্পাদনা করুন
• আপনার পোর্টাল থেকে একটি API সরান
• সম্পর্কিত API আবিষ্কার করতে ব্যবহৃত বিভাগগুলি পরিচালনা করুন
• পুরানো বা স্পেক স্টোর থেকে মুছে ফেলা হয়েছে এমন চশমাগুলি দ্রুত শনাক্ত করুন
• "অনাথ" এপিআইগুলিকে দ্রুত শনাক্ত করুন যার সংশ্লিষ্ট API পণ্য এজ থেকে সরানো হয়েছে, এবং API পণ্য পুনরায় তৈরি করুন বা আপনার পোর্টাল থেকে API মুছুন

আপনার পোর্টালে একটি API যোগ করুন

আপনার পোর্টালে একটি API যোগ করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs ট্যাবে ক্লিক করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।

3. + ক্লিক করুন।

   ক্যাটালগ ডায়ালগ প্রদর্শনে একটি API পণ্য যোগ করুন।

4. আপনি আপনার পোর্টালে যোগ করতে চান এমন API পণ্য নির্বাচন করুন।

5. পরবর্তী ক্লিক করুন. API বিবরণ পৃষ্ঠা প্রদর্শন করে।

6. API রেফারেন্স ডকুমেন্টেশন সামগ্রী এবং পোর্টালে এর দৃশ্যমানতা কনফিগার করুন:

   মাঠ	বর্ণনা
   প্রকাশিত হয়েছে	আপনার পোর্টালে API প্রকাশ করতে Published নির্বাচন করুন। আপনি API প্রকাশ করতে প্রস্তুত না হলে চেকবক্সটি অনির্বাচন করুন৷ আপনি পরে সেটিং পরিবর্তন করতে পারেন, যেমন আপনার পোর্টালে একটি API প্রকাশ করুন বা অপ্রকাশিত করুন ।
   প্রদর্শন শিরোনাম	আপনার API এর শিরোনাম আপডেট করুন যা ক্যাটালগে প্রদর্শিত হয়। ডিফল্টরূপে, API পণ্যের নাম ব্যবহার করা হয়। আপনি প্রদর্শনের শিরোনামটি পরে পরিবর্তন করতে পারেন, যেমন প্রদর্শনের শিরোনাম এবং বিবরণ সম্পাদনা করুন ।
   বর্ণনা প্রদর্শন করুন	ক্যাটালগে প্রদর্শিত আপনার API-এর বিবরণ আপডেট করুন। ডিফল্টরূপে, API পণ্যের বিবরণ ব্যবহার করা হয়। প্রদর্শনের শিরোনাম এবং বিবরণ সম্পাদনা করুন- এ বর্ণিত হিসাবে আপনি পরে প্রদর্শনের বিবরণ পরিবর্তন করতে পারেন।
   ডেভেলপারদের একটি কলব্যাক URL উল্লেখ করতে হবে	আপনি যদি অ্যাপ ডেভেলপারদের একটি কলব্যাক URL নির্দিষ্ট করতে চান তাহলে সক্ষম করুন৷ আপনি একটি API-এর জন্য কলব্যাক URL পরিচালনা করুন- এ বর্ণিত হিসাবে পরে কলব্যাক URL যোগ বা আপডেট করতে পারেন।
   API ডকুমেন্টেশন	একটি OpenAPI নথি ব্যবহার করতে: OpenAPI নথি নির্বাচন করুন। নথি নির্বাচন করুন ক্লিক করুন। নিম্নলিখিত পদক্ষেপগুলির মধ্যে একটি সম্পাদন করুন: My Specs ট্যাবে ক্লিক করুন এবং spec store থেকে একটি স্পেক নির্বাচন করুন। আপলোড ফাইল ট্যাবে ক্লিক করুন এবং একটি ফাইল আপলোড করুন। একটি URL ট্যাব থেকে আমদানি ক্লিক করুন এবং একটি URL থেকে একটি বিশেষ আমদানি করুন৷ নির্বাচন ক্লিক করুন. একটি GraphQL স্কিমা ব্যবহার করতে: GraphQL স্কিমা নির্বাচন করুন। ডকুমেন্ট নির্বাচন করুন ক্লিক করুন। গ্রাফকিউএল স্কিমাতে নেভিগেট করুন এবং নির্বাচন করুন। নির্বাচন ক্লিক করুন. বিকল্পভাবে, আপনি কোন ডকুমেন্টেশন নির্বাচন করতে পারেন না এবং API যোগ করার পরে একটি যোগ করতে পারেন, যেমন নথির স্ন্যাপশট পরিচালনায় বর্ণিত হয়েছে।
   API দৃশ্যমানতা	আপনি দর্শক পরিচালনা বৈশিষ্ট্যের বিটা রিলিজে নথিভুক্ত না হলে, নিম্নলিখিত বিকল্পগুলির মধ্যে একটি নির্বাচন করুন: বেনামী ব্যবহারকারীরা সকল ব্যবহারকারীদের API দেখার অনুমতি দেয়। নিবন্ধিত ব্যবহারকারীরা শুধুমাত্র নিবন্ধিত ব্যবহারকারীদের API দেখার অনুমতি দেয়। আপনি যদি দর্শক পরিচালনা বৈশিষ্ট্যের বিটা রিলিজে নথিভুক্ত হয়ে থাকেন, তাহলে নিম্নলিখিত বিকল্পগুলির মধ্যে একটি নির্বাচন করুন: সকল ব্যবহারকারীদের API দেখার অনুমতি দেওয়ার জন্য সর্বজনীন (কারো কাছে দৃশ্যমান) ৷ শুধুমাত্র নিবন্ধিত ব্যবহারকারীদের API দেখার অনুমতি দেওয়ার জন্য প্রমাণীকৃত ব্যবহারকারীরা । আপনি API দেখতে সক্ষম হতে চান এমন নির্দিষ্ট শ্রোতা নির্বাচন করতে নির্বাচিত দর্শক । আপনার পোর্টালে একটি API-এর দৃশ্যমানতা পরিচালনা করুন- এ বর্ণিত হিসাবে আপনি পরে দর্শকের দৃশ্যমানতা পরিচালনা করতে পারেন।
   চিত্র প্রদর্শন করুন	API পৃষ্ঠায় API কার্ডে একটি চিত্র প্রদর্শন করতে, চিত্র নির্বাচন করুন ক্লিক করুন। চিত্র নির্বাচন করুন ডায়ালগে, একটি বিদ্যমান চিত্র নির্বাচন করুন, একটি নতুন চিত্র আপলোড করুন, বা একটি বহিরাগত চিত্রের URL প্রদান করুন এবং নির্বাচন করুন ক্লিক করুন। API থাম্বনেইলের পূর্বরূপ দেখুন এবং নির্বাচন করুন ক্লিক করুন। একটি API কার্ডের জন্য চিত্র পরিচালনা করুন- এ বর্ণিত হিসাবে আপনি পরে একটি ছবি যোগ করতে পারেন। একটি বহিরাগত URL সহ একটি চিত্র নির্দিষ্ট করার সময়, ছবিটি আপনার সম্পত্তিতে আপলোড করা হবে না; উপরন্তু, সমন্বিত পোর্টালে ইমেজ লোড করা তার প্রাপ্যতা সাপেক্ষে হবে, যা বিষয়বস্তু নিরাপত্তা নীতি দ্বারা অবরুদ্ধ বা সীমাবদ্ধ হতে পারে।
   ক্যাটাগরি	যে বিভাগগুলিতে API-কে ট্যাগ করা হবে অ্যাপ ডেভেলপারদের APIs পৃষ্ঠায় সম্পর্কিত API আবিষ্কার করতে সক্ষম করতে সেগুলি যোগ করুন। একটি বিভাগ সনাক্ত করতে: ড্রপ-ডাউন তালিকা থেকে একটি বিভাগ নির্বাচন করুন। একটি নতুন বিভাগ যোগ করুন এর নাম লিখে এন্টার টিপে। নতুন বিভাগটি বিভাগ পৃষ্ঠায় যোগ করা হবে এবং অন্যান্য API যোগ বা সম্পাদনা করার সময় উপলব্ধ করা হবে।

7. Save এ ক্লিক করুন।

নথির স্ন্যাপশট পরিচালনা করুন

আপনি আপনার API প্রকাশ করার পরে, যে কোনো সময় আপনি আপনার পোর্টালে প্রকাশিত API রেফারেন্স ডকুমেন্টেশন আপডেট করতে OpenAPI বা GraphQL নথির একটি নতুন স্ন্যাপশট নিতে পারেন।

নথির স্ন্যাপশট পরিচালনা করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs ট্যাবে ক্লিক করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।
3. আপনি সম্পাদনা করতে চান এমন API-এর সারিতে ক্লিক করুন।
4. স্ন্যাপশট স্থিতি পরীক্ষা করুন. যদি এটি পুরানো হয় তবে নিম্নলিখিত বার্তাটি প্রদর্শিত হবে:
5. ক্লিক করুন .
6. নিম্নলিখিত কাজগুলির মধ্যে একটি সম্পাদন করুন:
   • পুরানো একটি OpenAPI নথির একটি স্ন্যাপশট রিফ্রেশ করতে, রিফ্রেশ স্ন্যাপশট ক্লিক করুন।
   • API এর জন্য ডকুমেন্টেশন তৈরি করতে ব্যবহৃত নথিটি পরিবর্তন করতে, API ডকুমেন্টেশনের অধীনে নথি নির্বাচন করুন ক্লিক করুন এবং নতুন নথি নির্বাচন করুন৷
7. Save এ ক্লিক করুন।

API রেফারেন্স ডকুমেন্টেশন নথি থেকে রেন্ডার করা হয় এবং API রেফারেন্স পৃষ্ঠায় যোগ করা হয়। স্ন্যাপশট অবস্থা বর্তমান আপডেট করা হয়েছে:

আপনার পোর্টালে একটি API প্রকাশ বা অপ্রকাশিত করুন

আপনার পোর্টালে একটি API প্রকাশ বা অপ্রকাশিত করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs ট্যাবে ক্লিক করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।
3. আপনি সম্পাদনা করতে চান এমন API-এর সারিতে ক্লিক করুন।
4. ক্লিক করুন .
5. API বিবরণের অধীনে, আপনার পোর্টালে যথাক্রমে API প্রকাশ বা অপ্রকাশিত করতে প্রকাশিত (ক্যাটালগে তালিকাভুক্ত) নির্বাচন বা অনির্বাচন করুন।
6. Save এ ক্লিক করুন।

আপনার পোর্টালে একটি API এর দৃশ্যমানতা পরিচালনা করুন

অ্যাক্সেসের অনুমতি দিয়ে আপনার পোর্টালে একটি API-এর দৃশ্যমানতা পরিচালনা করুন:

• সর্বজনীন (কারো কাছে দৃশ্যমান)
• প্রমাণীকৃত ব্যবহারকারী
• নির্বাচিত দর্শক (যদি আপনি দর্শক পরিচালনা বৈশিষ্ট্যের বিটা রিলিজে নথিভুক্ত হন)

আপনার পোর্টালে একটি API-এর দৃশ্যমানতা পরিচালনা করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs ট্যাবে ক্লিক করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।
3. আপনি সম্পাদনা করতে চান এমন API-এর সারিতে ক্লিক করুন।
4. ক্লিক করুন .
5. API দৃশ্যমানতার অধীনে, নিম্নলিখিত বিকল্পগুলির মধ্যে একটি নির্বাচন করুন:

6. দৃশ্যমানতা সেটিং নির্বাচন করুন। আপনি যদি শ্রোতা বৈশিষ্ট্যের বিটা রিলিজে নথিভুক্ত হয়ে থাকেন তবে নিম্নলিখিত বিকল্পগুলির মধ্যে একটি নির্বাচন করুন:

   • সকল ব্যবহারকারীদের পৃষ্ঠা দেখার অনুমতি দেওয়ার জন্য সর্বজনীন (কারো কাছে দৃশ্যমান) ৷
   • শুধুমাত্র নিবন্ধিত ব্যবহারকারীদের পৃষ্ঠা দেখার অনুমতি দেওয়ার জন্য প্রমাণীকৃত ব্যবহারকারীরা ।
   • আপনি পৃষ্ঠাটি দেখতে সক্ষম হতে চান এমন নির্দিষ্ট শ্রোতা নির্বাচন করতে নির্বাচিত শ্রোতা । আপনার পোর্টালের জন্য দর্শকদের পরিচালনা দেখুন।
   অন্যথায়, নিম্নলিখিত বিকল্পগুলির মধ্যে একটি নির্বাচন করুন:
   • বেনামী ব্যবহারকারীরা সমস্ত ব্যবহারকারীদের পৃষ্ঠাটি দেখার অনুমতি দেয়।
   • নিবন্ধিত ব্যবহারকারীরা শুধুমাত্র নিবন্ধিত ব্যবহারকারীদের পৃষ্ঠা দেখার অনুমতি দেয়।

7. জমা দিন ক্লিক করুন.

একটি API-এর জন্য কলব্যাক URL পরিচালনা করুন

একটি API-এর জন্য কলব্যাক URL পরিচালনা করুন। কলব্যাক URL সম্পর্কে দেখুন।

একটি API এর জন্য কলব্যাক URL পরিচালনা করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs ট্যাবে ক্লিক করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।
3. আপনি সম্পাদনা করতে চান এমন API-এর সারিতে ক্লিক করুন।
4. ক্লিক করুন .
5. API বিবরণের অধীনে, আপনার পোর্টালে যথাক্রমে API প্রকাশ বা অপ্রকাশিত করতে প্রকাশিত (ক্যাটালগে তালিকাভুক্ত) নির্বাচন বা অনির্বাচন করুন।
6. Save এ ক্লিক করুন।

একটি API কার্ডের জন্য ছবি পরিচালনা করুন

বর্তমান চিত্র যোগ বা পরিবর্তন করে API পৃষ্ঠায় একটি API কার্ডের সাথে প্রদর্শিত চিত্রটি পরিচালনা করুন।

একটি API কার্ডের জন্য চিত্র পরিচালনা করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs ট্যাবে ক্লিক করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।
3. আপনি সম্পাদনা করতে চান এমন API-এর সারিতে ক্লিক করুন।
4. ক্লিক করুন .

5. API বিবরণের অধীনে:

   • কোনো ছবি বর্তমানে নির্বাচিত না থাকলে নির্দিষ্ট করতে বা আপলোড করতে ছবি নির্বাচন করুন ক্লিক করুন।
   • একটি ভিন্ন চিত্র নির্দিষ্ট করতে বা আপলোড করতে চিত্র পরিবর্তন করুন ক্লিক করুন।
   • এটি অপসারণ করতে ছবিতে x এ ক্লিক করুন।

   একটি চিত্র নির্দিষ্ট করার সময়, ক্যাটালগ আইটেমের জন্য ব্যবহৃত একটি বহিরাগত URL সহ একটি চিত্র বা পোর্টালে সংরক্ষিত চিত্র ফাইলগুলির জন্য একটি ফাইল পাথ উল্লেখ করুন, উদাহরণস্বরূপ, /files/book-tree.jpg । একটি বহিরাগত ছবির URL উল্লেখ করার সময়, ছবিটি আপনার সম্পদে আপলোড করা হবে না; উপরন্তু, সমন্বিত পোর্টালে ইমেজ লোড করা তার প্রাপ্যতা সাপেক্ষে হবে, যা বিষয়বস্তু নিরাপত্তা নীতি দ্বারা অবরুদ্ধ বা সীমাবদ্ধ হতে পারে।

6. Save এ ক্লিক করুন।

বিভাগ ব্যবহার করে একটি API ট্যাগ করুন

নিম্নলিখিত উপায়ে বিভাগগুলি ব্যবহার করে একটি API ট্যাগ করুন:

• নীচে বর্ণিত হিসাবে API সম্পাদনা করার সময় একটি API ট্যাগ করা হয় এমন বিভাগগুলি পরিচালনা করুন৷
• বিভাগ সম্পাদনা করার সময় একটি বিভাগে ট্যাগ করা APIগুলি পরিচালনা করুন।

API সম্পাদনা করার সময় বিভাগগুলিতে একটি API ট্যাগ করতে:

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

প্রদর্শন শিরোনাম এবং বিবরণ সম্পাদনা করুন

প্রদর্শন শিরোনাম এবং বিবরণ সম্পাদনা করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs ট্যাবে ক্লিক করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।
3. আপনি সম্পাদনা করতে চান এমন API-এর সারিতে ক্লিক করুন।
4. ক্লিক করুন .
5. ডিসপ্লে শিরোনাম এবং ডিসপ্লে ডিসক্রিপশন ক্ষেত্রগুলি প্রয়োজন অনুযায়ী সম্পাদনা করুন।
6. Save এ ক্লিক করুন।

আপনার পোর্টাল থেকে একটি API সরান

আপনার পোর্টাল থেকে একটি API সরাতে:

1. API ক্যাটালগ অ্যাক্সেস করুন ।
2. APIs নির্বাচন করুন, যদি ইতিমধ্যে নির্বাচিত না হয়।
3. অ্যাকশন মেনু প্রদর্শন করতে তালিকার API-এর উপরে আপনার কার্সার রাখুন।
4. ক্লিক করুন .

সম্পর্কিত API আবিষ্কার করতে ব্যবহৃত বিভাগগুলি পরিচালনা করুন

লাইভ পোর্টালের APIs পৃষ্ঠায় সম্পর্কিত APIগুলি আবিষ্কার করতে অ্যাপ্লিকেশন বিকাশকারীদের সক্ষম করতে বিভাগগুলি ব্যবহার করে একটি API ট্যাগ করুন ৷ নিম্নলিখিত বিভাগে বর্ণিত হিসাবে বিভাগ যোগ করুন এবং পরিচালনা করুন।

বিভাগ পৃষ্ঠা অন্বেষণ

বিভাগ পৃষ্ঠা দেখতে:

1. প্রকাশ করুন > পোর্টাল নির্বাচন করুন এবং আপনার পোর্টাল নির্বাচন করুন।
2. পোর্টাল হোম পেজে API ক্যাটালগে ক্লিক করুন।

   বিকল্পভাবে, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনুতে API ক্যাটালগ নির্বাচন করতে পারেন।

3. বিভাগ ট্যাবে ক্লিক করুন।

API ক্যাটালগের ক্যাটাগরি ট্যাব আপনার পোর্টালের জন্য সংজ্ঞায়িত করা বিভাগগুলির তালিকা প্রদর্শন করে।

আগের চিত্রে যেমন হাইলাইট করা হয়েছে, APIs পৃষ্ঠা আপনাকে এতে সক্ষম করে:

• বিভাগগুলি এবং APIগুলি দেখুন যেখানে তারা ট্যাগ করা হয়েছে৷
• একটি বিভাগ যোগ করুন
• একটি বিভাগ সম্পাদনা করুন
• একটি বিভাগ মুছুন
• আপনার পোর্টালে প্রকাশিত APIগুলি পরিচালনা করুন। API ক্যাটালগ অন্বেষণ দেখুন

একটি বিভাগ যোগ করুন

নিম্নলিখিত উপায়ে একটি বিভাগ যোগ করুন:

• পোর্টালে একটি API যোগ করার সময় একটি বিভাগের নাম লিখুন
• নীচে বর্ণিত হিসাবে ম্যানুয়ালি একটি বিভাগ যোগ করুন

নতুন বিভাগটি বিভাগ পৃষ্ঠায় যোগ করা হবে এবং অন্যান্য API যোগ বা সম্পাদনা করার সময় উপলব্ধ করা হবে।

ম্যানুয়ালি একটি বিভাগ যোগ করতে:

1. বিভাগ পৃষ্ঠা অ্যাক্সেস করুন .
2. + ক্লিক করুন।
3. আপনার নতুন বিভাগের নাম লিখুন।
4. ঐচ্ছিকভাবে, বিভাগে ট্যাগ করতে এক বা একাধিক API নির্বাচন করুন।
5. তৈরি করুন ক্লিক করুন।

একটি বিভাগ সম্পাদনা করুন

একটি বিভাগ সম্পাদনা করতে:

1. বিভাগ পৃষ্ঠা অ্যাক্সেস করুন .
2. ক্লিক করুন .
3. বিভাগের নাম সম্পাদনা করুন।
4. API ট্যাগ যোগ করুন বা সরান।
5. Save এ ক্লিক করুন।

একটি বিভাগ মুছুন

আপনি একটি বিভাগ মুছে ফেললে, সেই বিভাগের সমস্ত API ট্যাগগুলিও মুছে ফেলা হয়।

একটি বিভাগ মুছে ফেলতে:

1. বিভাগ পৃষ্ঠা অ্যাক্সেস করুন .
2. কর্ম মেনু প্রদর্শন করতে আপনি যে বিভাগে সম্পাদনা করতে চান তার উপরে আপনার কার্সার রাখুন।
3. ক্লিক করুন .
4. বিভাগের নাম সম্পাদনা করুন।
5. API যোগ করুন বা সরান।
6. Save এ ক্লিক করুন।

আপনার প্রকাশিত APIগুলির সাথে সমস্যাগুলি সমাধান করুন৷

নিম্নলিখিত বিভাগগুলি আপনাকে আমাদের প্রকাশিত APIগুলির সাথে নির্দিষ্ট ত্রুটিগুলির সমস্যা সমাধানে সহায়তা করার জন্য তথ্য প্রদান করে৷

ত্রুটি: এই API ব্যবহার করে দেখুন ত্রুটি ফেরত আনতে ব্যর্থ হয়েছে

এই API ব্যবহার করে দেখুন, যদি TypeError: Failed to fetch error ফেরত দেওয়া হয়, তাহলে নিম্নলিখিত সম্ভাব্য কারণ এবং রেজোলিউশন বিবেচনা করুন:

• মিশ্র বিষয়বস্তু ত্রুটির জন্য, একটি পরিচিত swagger-ui সমস্যার কারণে ত্রুটি হতে পারে৷ একটি সম্ভাব্য সমাধান হল আপনি আপনার OpenAPI নথিতে schemes সংজ্ঞাতে HTTP-এর আগে HTTPS নির্দিষ্ট করেছেন তা নিশ্চিত করা। যেমন:

  schemes:
     - https
     - http
  

• ক্রস-অরিজিন রিসোর্স শেয়ারিং (CORS) সীমাবদ্ধতা ত্রুটির জন্য, নিশ্চিত করুন যে CORS আপনার API প্রক্সিগুলির জন্য সমর্থিত। CORS হল একটি আদর্শ প্রক্রিয়া যা ক্লায়েন্ট-সাইড ক্রস-অরিজিন অনুরোধগুলিকে সক্ষম করে। সমর্থন করার জন্য আপনার API প্রক্সি কনফিগার করুন দেখুন এই API ব্যবহার করে দেখুন ।

ত্রুটি: 'অ্যাক্সেস-কন্ট্রোল-অ্যালো-অরিজিন' হেডারে একাধিক মান রয়েছে '*, *', কিন্তু শুধুমাত্র একটি অনুমোদিত

এই API ব্যবহার করে দেখুন, যদি Access-Control-Allow-Origin শিরোনামটি ইতিমধ্যেই বিদ্যমান থাকে তবে আপনি নিম্নলিখিত ত্রুটি বার্তা পেতে পারেন:

The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

এই ত্রুটিটি সংশোধন করার জন্য, নিচের অংশে দেখানো হিসাবে <Add> এর পরিবর্তে CORS হেডার সেট করতে <Set> ব্যবহার করতে AssignMessage নীতি পরিবর্তন করুন। আরও তথ্যের জন্য, প্রাসঙ্গিক সম্প্রদায় নিবন্ধটি দেখুন।

<AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

ত্রুটি: অনুরোধ শিরোনাম ক্ষেত্র অনুমোদিত নয়

এই API ব্যবহার করে দেখুন, যদি আপনি একটি Request header field not allowed , নীচের উদাহরণের মতো, আপনাকে CORS নীতিতে সমর্থিত শিরোনামগুলি আপডেট করতে হতে পারে৷ যেমন:

Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

এই উদাহরণে, আপনাকে আপনার CORS অ্যাসাইনমেসেজ নীতির Access-Control-Allow-Headers বিভাগে content-type শিরোনাম যোগ করতে হবে, যেমনটি একটি নতুন API প্রক্সিতে একটি CORS নীতি যুক্ত করার বর্ণনায় বর্ণিত হয়েছে।

ত্রুটি: OAuth2 ব্যবহার করে একটি API প্রক্সি কল করার সময় অ্যাক্সেস অস্বীকার করা হয়েছে৷

Apigee-এর OAuthV2 নীতি একটি টোকেন প্রতিক্রিয়া প্রদান করে যাতে নির্দিষ্ট কিছু নন-RFC-সঙ্গত বৈশিষ্ট্য রয়েছে। উদাহরণ স্বরূপ, নীতিটি প্রত্যাশিত RFC-সঙ্গত মান Bearer এর পরিবর্তে BearerToken মান সহ একটি টোকেন ফেরত দেবে। এই অবৈধ token_type প্রতিক্রিয়ার ফলে এই API ব্যবহার করে দেখুন একটি Access denied ত্রুটি হতে পারে৷

এই সমস্যাটি সংশোধন করতে, আপনি একটি জাভাস্ক্রিপ্ট বা AssignMessage নীতি তৈরি করতে পারেন যাতে নীতির আউটপুটকে একটি সঙ্গতিপূর্ণ বিন্যাসে রূপান্তর করা যায়। আরও তথ্যের জন্য, নন-RFC-সঙ্গত আচরণ দেখুন।