API ও Integration
নথিভুক্ত inference API বা model-training API, সীমিত পরিসরের credential এবং চলতি usage ও API reference দিয়ে অ্যাপ্লিকেশন সংযুক্ত করুন।
- API পণ্য বাছাইInference request ও model-training workflow আলাদা করে চিনুন।
- এর contract পড়ুনসংশ্লিষ্ট API ডকুমেন্টেশন ও OpenAPI reference ব্যবহার করুন।
- সীমিত scope-এর key তৈরিগ্রাহক API key তৈরি করে নিরাপদে সংরক্ষণ করুন।
- Integration ও যাচাইনথিভুক্ত request পাঠিয়ে response পরীক্ষা করুন।
- পর্যবেক্ষণ ও rotationব্যবহার পর্যালোচনা করুন; প্রয়োজনমতো key প্রত্যাহার বা rotate করুন।
সঠিক API workflow বেছে নিন
Inference API মডেল inference request পরিবেশন করে; model-training API-তে quote, job, session ও artifact-সহ আলাদা training workflow নথিভুক্ত। Inference endpoint training শুরু করে বা inference contract দিয়ে training operation পাওয়া যায়—এমন ধরে নেবেন না। যে পণ্য ব্যবহার করবেন তার ডকুমেন্টেশন পড়ুন এবং মডেল বা training capability তালিকাভুক্ত আছে কি না নিশ্চিত করুন। পরিচিত তৃতীয় পক্ষের SDK দেখে method name অনুমান না করে প্রকাশিত request ও response structure ব্যবহার করুন।
- অ্যাপ্লিকেশনে inference না model training দরকার তা নির্ধারণ করুন।
- সংশ্লিষ্ট পণ্যের ডকুমেন্টেশন ও API reference খুলুন।
- চাওয়া capability ও model নথিভুক্ত আছে কি না নিশ্চিত করুন।
API key তৈরি ও সুরক্ষিত রাখুন
সাইন-ইন করা API-key পৃষ্ঠা থেকে গ্রাহক API key তৈরি করুন এবং interface-এ scope বেছে নেওয়ার সুবিধা থাকলে integration-এর প্রয়োজনীয় ন্যূনতম scope দিন। Secret একবারই দেখানো হয়; তাই সরাসরি অনুমোদিত secret manager-এ রাখুন। Source control-এ commit, log-এ paste বা browser code-এ প্রকাশ করবেন না। সম্ভব হলে application ও environment অনুযায়ী credential-এর নাম দিন। Development ও production-এর জন্য আলাদা credential রাখুন, যাতে একটিকে প্রত্যাহার করলে অসংশ্লিষ্ট integration বন্ধ না হয়।
- সাইন-ইন করা customer workspace থেকে API keys খুলুন।
- প্রয়োজনীয় সর্বনিম্ন scope-সহ key তৈরি করুন।
- Secret নিরাপদে রাখুন; source code ও log থেকে দূরে রাখুন।
নথিভুক্ত contract অনুযায়ী বাস্তবায়ন
Authentication, endpoint, request field, response ব্যবস্থাপনা ও error-এর জন্য সংশ্লিষ্ট API নির্দেশিকা অনুসরণ করুন। Service credential বিশ্বস্ত server-এ রাখুন, public client code-এ নয়। পাঠানোর আগে input যাচাই করুন, non-success response স্পষ্টভাবে সামলান এবং authorization header বা সংবেদনশীল prompt data log করবেন না। প্রকাশিত machine-readable contract দরকার হলে OpenAPI reference ব্যবহার করুন। চলতি ডকুমেন্টেশনে স্পষ্টভাবে তালিকাভুক্ত না থাকলে streaming, media বা provider-native operation সমর্থিত ধরে নেবেন না।
- নির্বাচিত API-তে বর্ণিত operation ও field-ই বাস্তবায়ন করুন।
- Credential server-এ রাখুন এবং diagnostic log থেকে গোপন করুন।
- নথিভুক্ত error সামলান এবং দেওয়া হলে request identifier সংরক্ষণ করুন।
ব্যবহার পর্যবেক্ষণ ও credential পরিচালনা
Integration-এর পর Usage পৃষ্ঠা দেখে অ্যাকাউন্টের activity বুঝুন এবং নিজের application record-এর সঙ্গে তুলনা করুন। Traffic বাড়ানো বা নতুন credential তৈরির আগে অপ্রত্যাশিত পরিবর্তন তদন্ত করুন। Key প্রকাশ হয়ে থাকতে পারে মনে হলে সেটি rotate করুন, application-এর secret store হালনাগাদ করুন এবং পুরোনো credential সরানোর আগে integration যাচাই করুন। আর প্রয়োজন নেই এমন key প্রত্যাহার করুন। Usage display পরিচালনাগত পর্যালোচনায় সহায়ক, কিন্তু ভবিষ্যৎ charge বা capacity-এর নিশ্চয়তা নয়।
- Platform usage-এর সঙ্গে application-এর request record তুলনা করুন।
- প্রকাশিত credential rotate করে replacement যাচাই করুন।
- অব্যবহৃত key প্রত্যাহার করে নিয়মিত access পর্যালোচনা করুন।
সাধারণ জিজ্ঞাসা
Inference ও model training কি একই API?
না। এগুলো ভিন্ন workflow-সহ আলাদা পণ্য। প্রয়োজনীয় capability-এর reference অনুসরণ করুন।
সমর্থিত API contract কোথায় পাব?
এই নির্দেশিকার সঙ্গে যুক্ত পণ্যের ডকুমেন্টেশন ও OpenAPI reference ব্যবহার করুন। সেখানে বর্তমানে প্রকাশিত interface বর্ণিত।
API secret কোথায় রাখব?
নিরাপদ server-side secret manager ব্যবহার করুন। Repository-তে commit, browser code-এ প্রকাশ বা log-এ লেখা কখনোই করবেন না।
Key প্রকাশ হয়ে গেলে কী করব?
API keys থেকে rotate বা প্রত্যাহার করুন, application-এর secret store-এ বদলান এবং সাম্প্রতিক usage-এ অপ্রত্যাশিত activity দেখুন।