কী Cato API

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

সংক্ষিপ্ত বিবরণ

Cato API হল সিমলেস ইন্টেগ্রেশন নিশ্চিত করার জন্য প্রাথমিক অটোমেশন ইন্টারফেস Cato ক্লাউডের সঙ্গে। Cato APIs ব্যবহার করুন কার্যকরী অপারেশনাল ওয়ার্কফ্লো যেমন: ডিপ্লয়মেন্ট এবং কনফিগারেশন সেটাপ, ব্যাপক স্ট্যাটাস মনিটরিং, পরিসংখ্যান এবং ডেটা সংগ্রহ, এবং অ্যানালিটিক্স আপনার নেটওয়ার্ক এবং নিরাপত্তা ব্যবস্থাপনাকে সহজতর করতে।

Cato API এন্ডপয়েন্ট এবং স্কিমা

API এন্ডপয়েন্ট এবং স্কিমার জন্য URL নির্দিষ্ট আপনার Cato ম্যানেজমেন্ট অ্যাপ্লিকেশন (CMA) ইন্সট্যান্স যেখানে হোস্ট করা আছে তার জন্য। এটা হতে পারে যে <প্রিফিক্স> মান URL এর CMA অ্যাকাউন্ট এবং API এন্ডপয়েন্ট এবং স্কিমার সাথে যুক্ত করা হয়েছে।

API এন্ডপয়েন্টের জন্য URL ফরম্যাটের মধ্যে রয়েছে, https://api.<prefix>.catonetworks.com/api/v1/graphql2।

API স্কিমার জন্য URL ফরম্যাটের মধ্যে রয়েছে, https://api.<prefix>.catonetworks.com/api/schema।

API এন্ডপয়েন্টের URL

যদি কোন প্রিফিক্স না থাকে (cc.catonetworks.com), তাহলে নিম্নলিখিত URL ব্যবহার করুন: https://api.catonetworks.com/api/v1/graphql2
যদি প্রিফিক্স থাকে (যেমন cc.us1.catonetworks.com), তাহলে নিম্নলিখিত URL ব্যবহার করবেন (বিভিন্ন লোকেশনের জন্য প্রিফিক্স পরিবর্তন করুন): https://api.us1.catonetworks.com/api/v1/graphql2

API স্কিমার জন্য URL

যদি কোন প্রিফিক্স না থাকে (cc.catonetworks.com), তাহলে নিম্নলিখিত URL ব্যবহার করুন: https://api.catonetworks.com/api/schema
যদি প্রিফিক্স থাকে (যেমন cc.us1.catonetworks.com), তাহলে নিম্নলিখিত URL ব্যবহার করবেন (বিভিন্ন লোকেশনের জন্য প্রিফিক্স পরিবর্তন করুন): https://api.us1.catonetworks.com/api/schema

API স্কিমা ডকুমেন্টেশন

Cato APIs গ্রাফকিউএল ভিত্তিক একটি ইন্টুইটিভ ইন্টারফেস প্রদান করেছে যা RESTful API সরঞ্জাম এবং ক্লায়েন্টের সাথে পুরোপুরি সামঞ্জস্যপূর্ণ। গ্রাফকিউএল অতিরিক্ত সুবিধা প্রদান করে সঠিকভাবে প্রয়োজনীয় ডেটা অনুসন্ধান করতে সক্ষম করে, ফেচিং কমিয়ে এবং কার্যকারিতা উন্নত করে।

Cato API ডকুমেন্টেশন পাওয়া যায় Cato নেটওয়ার্কস গ্রাফকিউএল API রেফারেন্স-এ, যেটি অন্তর্ভুক্ত করে:

স্কিমা সংজ্ঞা এবং ডকুমেন্টেশন
উদাহরণ API কলগুলির সঙ্গে সম্পর্কিত নমুনা উত্তর
গ্রাফকিউএল API এন্ডপয়েন্ট একটি ইন্টারেক্টিভ প্লে‌গ্রাউন্ড সহ অনুসন্ধান এবং পরীক্ষা করার জন্য

API লাইফসাইকেল

এই বিভাগটি API এর নির্দিষ্ট পরিপক্কতা স্তর এবং উপলভ্যতার উপর ভিত্তি করে বিভিন্ন লাইফসাইকেল অবস্থা বর্ণনা করে।

প্রথমে, নতুন API বিটা স্তরে প্রকাশিত হয়। বিটা থেকে GA এ রূপান্তর অভ্যন্তরীণ পর্যালোচনা এবং বিবেচনার উপর নির্ভর করে যাতে API স্থিতিশীল এবং উৎপাদন-প্রস্তুত। সাধারণত বিটা থেকে GA এ স্থানান্তর এক বছরের মতো সময় নেয়।

টীকা

দ্রষ্টব্য: নীচে উল্লেখিত লাইফসাইকেল কেবলমাত্র Cato API ফরমালভাবে সংজ্ঞায়িত Cato নেটওয়ার্কস গ্রাফকিউএল API রেফারেন্স-এ প্রযোজ্য। এটি কোনও অতিরিক্ত সরঞ্জাম এবং উদাহরণের সাথে সম্পর্কিত নয় যা রেফারেন্স হিসেবে প্রদান করা হয়ে থাকতে পারে।

উদাহরণস্বরূপ, এটি ওপেন সোর্স উদাহরণ এবং সাদাসিধে Cato গিটহাব অ্যাকাউন্টে পাওয়া যায় না। এই সংস্থানগুলি শুধুমাত্র "যেমন আছে" প্রদান করা হয় কোন ওয়ারেন্টি বা আরও উন্নয়ন, রক্ষণাবেক্ষণ বা সহায়তার বাধ্যবাধকতা ছাড়াই।

API পরিপক্কতা স্তর

এগুলি হল API পরিপক্কতা স্তর লাইফসাইকেল পর্যায়ের অংশ হিসেবে:

বিটা: API গুলি যা বিটা পথমসতিকায় আছে, তা বৈশিষ্ট্যে পরিপূর্ণ এবং সম্পূর্ণরূপে কর্মক্ষম বিবেচিত হয়, যা প্রোডাকশন পরিবেশে ব্যবহারের জন্য উপযুক্ত। তবে, সেগুলি ব্যবহারকারীর প্রতিক্রিয়া বা অতিরিক্ত বিবেচনার উপর ভিত্তি করে পরিবর্তন হতে পারে। এই পরিবর্তনগুলি, API স্কিমায় ভাঙ্গন সৃষ্টি করলেও, সংক্ষিপ্ত নোটিশে ঘটতে পারে এবং ক্লায়েন্ট কোড আপডেটের প্রয়োজন হতে পারে।
GA (জেনারেল অ্যাভেলেবেলিটি): GA তে থাকা API গুলি স্থিতিশীল, উৎপাদন-প্রস্তুত এবং দীর্ঘমেয়াদী সমর্থন এবং পেছনের সামঞ্জস্যের প্রতিশ্রুতি প্রদান করে। API স্কিমার ভঙ্গকারী পরিবর্তনগুলি বিরল এবং বেশিরভাগ ক্ষেত্রেই ক্লায়েন্ট কোড সমন্বয়ের জন্য যথেষ্ট সময় দিয়ে আগে থেকে জানানোর মাধ্যমে ঘটানো হয়।

যে API গুলি স্পষ্টভাবে বিটা চিহ্নিত নয়, সেগুলি GA হিসেবে বিবেচিত। কিছু ক্ষেত্রে, GA API এর ভিতরে পৃথক ফিল্ড, টাইপ এবং ইনপুট বিটা হিসেবে চিহ্নিত হতে পারে।

API উপলভ্যতা স্তর

এগুলি হল API এর উপলভ্যতা স্তর যা লাইফসাইকেল স্তরের অংশ:

EA (আর্লি অ্যাভেলেবেলিটি): EA তে API গুলি পরীক্ষামূলক এবং প্রতিক্রিয়ার জন্য একটি সীমিত ব্যবহারকারী গোষ্ঠীর জন্য উপলব্ধ। অ্যাক্সেসের জন্য বিশেষ অনুমোদন বা শর্তাদি প্রয়োজন হতে পারে।
গ্র্যাডুয়াল রোলআউট: কাঠামোবদ্ধ পরিষেবার জন্য প্রতিদিনের শিল্প সেরা অনুশীলনগুলির অনুসরণে, Cato API গুলি ধীরে ধীরে রোলআউট করা হয় স্থিতিশীলতা নিশ্চিত করার জন্য এবং পারফরম্যান্সের পর্যবেক্ষণের জন্য।

EA বা গ্র্যাডুয়াল রোলআউট চিহ্নিত না করা API গুলি সম্পূর্ণ বিতরণ এবং সব ব্যবহারকারীর জন্য প্রবেশযোগ্য হিসেবে বিবেচিত।

API লেবেলগুলির সংক্ষিপ্তসার

এই বিভাগটি API ডকুমেন্টেশনে ব্যবহৃত লেবেলগুলি সংক্ষেপে উল্লেখ করে, পরিপক্কতা এবং উপলভ্যতা স্তরের ভিত্তিতে।

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

EA
- কেবলমাত্র সেই ক্লায়েন্টদের জন্য উপলভ্য যারা Cato এর EA প্রোগ্রামে যোগদান করেছেন, যোগদানের জন্য আমাদের সাথে যোগাযোগ করুন ea@catonetworks.com
বিটা
- স্কিমায় পরিবর্তনের সম্ভাবনা রয়েছে
- বিভাজনকারী পরিবর্তনের জন্য সীমিত নোটিশ, সম্ভবত দুই সপ্তাহের মতো কম
- বিটা API পূর্ণ কার্যকারিতার সমর্থন প্রদান করে
রোলআউট
- এই GA API গুলি কয়েক সপ্তাহ সময় ধরে সকল অ্যাকাউন্টে ধীরে ধীরে রোল আউট হয়ে যাচ্ছে
- রোলআউট অবস্থায় থাকা API কল করার সময় একটি ত্রুটি বার্তা দেখা দিতে পারে কারণ API এখনো আপনার অ্যাকাউন্টের জন্য উপলভ্য নয়

সম্ভাব্য ভঙ্গকারী স্কিমা পরিবর্তন

এই বিভাগে আলোচনা করা হয়েছে কখন Cato গ্রাফকিউএল API স্কিমায় পরিবর্তন করে যা API কলের আচরণ এবং ফলাফলকে প্রভাবিত করতে পারে।

গ্রাফকিউএলে সম্ভাব্য ভঙ্গকারী পরিবর্তন কী?

গ্রাফকিউএলে একটি সম্ভাব্য ভঙ্গকারী পরিবর্তন ঘটে যখন API তে পরিবর্তনগুলি ক্লায়েন্ট অ্যাপ্লিকেশনগুলিকে তাদের অনুসন্ধান বা লজিকে আপডেট করতে প্রয়োজনীয় হয় ফাংশনালিটি বজায় রাখতে। উদাহরণ অন্তর্ভুক্ত:

একটি ফিল্ড, টাইপ, বা আর্গুমেন্ট অপসারণ।
ফিল্ড, টাইপ, বা আর্গুমেন্ট রেনেমিং।
আর্গুমেন্টের ডিফল্ট মানগুলি সংশোধন যা অনুসন্ধান বা মিউটেশন এর প্রত্যাশিত ফলাফল পরিবর্তন করে।
একটি ফিল্ডের টাইপ বা আচরণ পরিবর্তন করা যা সামঞ্জস্যতাকে প্রভাবিত করে। উদাহরণস্বরূপ, একটি ফিল্ডের টাইপ পরিবর্তন করা (যেমন Int থেকে String) অথবা একটি আর্গুমেন্টের নাল্যাবিলিটি পরিবর্তন করা (যেমন, নাল্যাবল থেকে নন-নাল্যাবল)।

সম্ভাব্য ভঙ্গকারী পরিবর্তনগুলি ঘোষণা এবং ব্যবস্থা করা

আমরা সম্ভাব্য ভঙ্গকারী পরিবর্তনগুলি সম্ভাব্য ভঙ্গকারী পরিবর্তনগুলি এড়াতে যতটা সম্ভব কঠোর পরিশ্রম করি। তবে, যে বিরল সময়ে এরকম একটি পরিবর্তন ঘটে, তা গ্রাহকদের অবগত করা হবে নীচে বর্ণিত eol APIs তথ্য অনুযায়ী eol API সম্পর্কে বিজ্ঞপ্তি.

এই পরিবর্তনগুলি বিটা API এর জন্য বেশি ঘন হয় কিন্তু GA API এর ক্ষেত্রে বিরল।

অপ্রচলিত API

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

ইওএল API সম্পর্কে বিজ্ঞপ্তি

যদি একটি API বা ফিল্ড অপসারণ বা প্রতিস্থাপিত হওয়ার পরিকল্পনা থাকে, এটি একটি অবসান প্রক্রিয়া (EoL) এর মধ্য দিয়ে যাবে। এই প্রক্রিয়ায় নিম্নলিখিত পদক্ষেপগুলি অন্তর্ভুক্ত:

API বা ফিল্ডকে অপ্রচলিত হিসেবে চিহ্নিত করা
1. যে API বা ফিল্ড অপসারণের পরিকল্পনা করা হয়েছে, তা অপ্রচলিত হিসেবে চিহ্নিত করা হয় কাটো নেটওয়ার্কস গ্রাফQL API রেফারেন্স-এ।
2. এই লেবেলটি একটি বার্তা সহ আসে, যেখানে প্রযোজ্য ক্ষেত্রে একটি বিকল্প API বা ফিল্ড নির্দিষ্ট করে এবং পরিকল্পিত ইওএল তারিখ প্রদান করে।
ইওএল বিজ্ঞপ্তি
1. Cato API সম্ভাব্য ভঙ্গকারী এবং ইওএল প্রবন্ধটি নির্দিষ্ট তারিখ সহ আপডেট করা হয় যার মধ্যে পরিবর্তনের মাধ্যমে স্কিমা আপডেট করা হবে।
2. বিজ্ঞপ্তি এবং স্কিমা পরিবর্তনের মধ্যে সময়কাল নিম্নরূপ:
  - GA API: কমপক্ষে 3 মাস আগে থেকে এবং সাধারণত 6 মাস আগে থেকে
  - বিটা API: সাধারণত 2 সপ্তাহ আগে থেকে
3. ইওএল বিজ্ঞপ্তি এবং ইওএল তারিখের মধ্যে সময়কালের মধ্যে, গ্রাহকরা আশা করেন যে ক্লায়েন্ট কোডটি পরিবর্তিত করা হবে গ্রাফQL স্কিমার পরিবর্তনগুলি মানানসই করার জন্য।

অভঙ্গকারী স্কিমা পরিবর্তন

গ্রাফকিউএল এর মধ্যে গুরুত্বপূর্ণ পরিবর্তনগুলি এখনও ভঙ্গকারী নয়, যেমন নতুন API বা নতুন ফিল্ড, Cato API পরিবর্তন লগ প্রবন্ধে ঘোষণা করা হয়।

Cato নেটওয়ার্কস গ্রাফকিউএল API রেফারেন্স সর্বদা সম্পূর্ণভাবে সমর্থিত সর্বশেষ আপডেট প্রাপ্ত গ্রাফকিউএল স্কিমা অন্তর্ভুক্ত করে।