এই তালিকা সম্পর্কে
অধিকাংশ API নথিপত্রে যেখানে ভুল হয়
অনেক নির্দেশিকায় এন্ডপয়েন্টগুলোর তালিকা থাকে ঠিকই, কিন্তু যে বিবরণগুলো প্রকৃতপক্ষে বিভ্রান্তির সৃষ্টি করে সেগুলো বাদ পড়ে যায়: বাস্তবে প্রমাণীকরণ (authentication) কীভাবে কাজ করে, সঠিক রিকোয়েস্ট ও রেসপন্সের উদাহরণ, এবং নির্দিষ্ট ত্রুটিগুলোর অর্থ কী ও কীভাবে সেগুলো সমাধান করতে হবে। এমনটি ঘটলে, ডেভেলপাররা সাপোর্ট টিকিট জমা দিতে বাধ্য হন, যা নথিপত্র থাকার মূল উদ্দেশ্যকেই ব্যর্থ করে দেয়।
আমাদের পদ্ধতি
অনুমানের ওপর নির্ভর না করে আমরা সরাসরি আপনার সোর্স কোড থেকে কাজ শুরু করি। লাইভ ক্রেডেনশিয়াল ব্যবহার করে নিজেরা API পরীক্ষা করার আগে আমরা আপনার রুট, ভ্যালিডেশন লজিক এবং ত্রুটি মোকাবিলার প্রক্রিয়াগুলো খতিয়ে দেখি। চূড়ান্ত নথিপত্রের প্রতিটি উদাহরণই আমাদের পাঠানো একটি বাস্তব রিকোয়েস্ট এবং প্রাপ্ত রেসপন্সকে নির্দেশ করে, যা নিশ্চিত করে যে এতে কোনো কাল্পনিক বিবরণ বা অসম্ভব স্ট্যাটাস কোড নেই।
আপনি যা পাবেন
- প্রমাণীকরণ সংক্রান্ত নির্দেশিকা: টোকেন ইস্যু করা, রিফ্রেশ করা, এবং সেশনের মাঝপথে এর মেয়াদ শেষ হয়ে গেলে কী হবে।
- প্রতিটি এন্ডপয়েন্টের সম্পূর্ণ বিবরণ, যার মধ্যে রয়েছে প্যারামিটার, একটি কার্যকর উদাহরণ রিকোয়েস্ট এবং আসল রেসপন্সের কাঠামো।
- ত্রুটির একটি রেফারেন্স যা প্রতিটি কোডকে কেবল বার্তাটি পুনরায় উল্লেখ না করে এর কারণ এবং সমাধানের সাথে সংযুক্ত করে।
- একজন নতুন ডেভেলপারকে একদম শুরু থেকে একটি সফল কল সম্পন্ন করতে সাহায্য করার জন্য তৈরি একটি কুইক-স্টার্ট পাথ।
- যেখানে প্রাসঙ্গিক সেখানে রেট লিমিট, পেজিনেশন, ওয়েবহুক এবং আইডেমপোটেন্সি সম্পর্কিত নোট।
সরবরাহের ফরম্যাট
আমরা আপনার রিপোজিটরির উপযোগী করে Markdown প্রদান করি, যা এমনভাবে সাজানো থাকে যেন তা OpenAPI বা কোনো নথিপত্রের সাইটের সাথে মানানসই হয়—আপনার দল যেটি আপডেট রাখবে। কোডের নমুনাগুলো আপনার ব্যবহারকারীরা যেসব ভাষা ব্যবহার করেন সেগুলোতে সরবরাহ করা হয় এবং সেগুলো চালিয়ে পরীক্ষা করা হয়। অনুরোধের ভিত্তিতে একটি Postman-শৈলীর কালেকশনও অন্তর্ভুক্ত করা যেতে পারে।
আপনার কাছ থেকে আমাদের যা প্রয়োজন
আপনার রিপোজিটরি বা OpenAPI ফাইলে অ্যাক্সেস, টেস্ট এনভায়রনমেন্টের জন্য একটি কার্যকর ক্রেডেনশিয়াল, এবং আপনার সাপোর্ট কর্মীরা যেসব প্রশ্নের উত্তর সবচেয়ে বেশি দেন—এগুলো নির্দেশিকার কাঠামো তৈরি করতে সাহায্য করে।
যা অন্তর্ভুক্ত নয়
এই পরিষেবাটিতে সফটওয়্যার কীভাবে কাজ করে তার সুনির্দিষ্ট প্রযুক্তিগত নথিপত্র অন্তর্ভুক্ত; প্রচারমূলক বা বিপণনমূলক লেখা একটি পৃথক কাজ।
প্রক্রিয়া এবং সময়সীমা
আপনি একটি সম্পূর্ণ প্রাথমিক খসড়া পাবেন, যা আপনি আপনার সাপোর্ট দলের নিয়মিত পাওয়া প্রশ্নগুলোর সাথে মিলিয়ে দেখতে পারেন। কোনো পরিপাটি অথচ ভুল তথ্য সম্বলিত কাজ হস্তান্তর করার চেয়ে শুরুতেই কোনো ইঞ্জিনিয়ারের মাধ্যমে বিশেষ কোনো ক্ষেত্র চিহ্নিত করানোকে আমরা বেশি প্রাধান্য দিই। যেহেতু প্রতিটি উদাহরণ আপনার লাইভ API-এর বিপরীতে চালিয়ে দেখা হয়েছে, তাই চূড়ান্ত নথির কোনো কিছুই তাত্ত্বিক নয়।
এই প্যাকেজে একবারে সরবরাহযোগ্য নির্দিষ্ট মূল্যের একটি API নথিপত্রের পরিধি অন্তর্ভুক্ত, যাতে একবার সংশোধনের সুযোগ রয়েছে, এর মূল্য 500.99 USD এবং সময়সীমা ১০ দিন। আপনাকে যে ডোমেইনের সাথে অর্ডারটি সম্পর্কিত তা এবং আপনার সংক্ষিপ্ত বিবরণ প্রদান করতে হবে।