নির্দেশিকা
ফ্রস্টফয় এপিআই ব্যবহারের জন্য সেরা অনুশীলন এবং উন্নত বিষয়গুলি শিখুন।
ত্রুটি ব্যবস্থাপনা
HTTP স্ট্যাটাস কোডসমূহ
ফ্রস্টফয় এপিআই স্ট্যান্ডার্ড HTTP স্ট্যাটাস কোড ব্যবহার করে অনুরোধের ফলাফল নির্দেশ করে:
200সফলঅনুরোধ সফলভাবে প্রক্রিয়া করা হয়েছে
400খারাপ অনুরোধঅনুরোধে অবৈধ প্যারামিটার বা মিসিং প্রয়োজনীয় ক্ষেত্র রয়েছে
401অননুমোদিতএপিআই কী অবৈধ বা অনুপস্থিত
403নিষিদ্ধএপিআই কী এই এন্ডপয়েন্টে অ্যাক্সেস করার অনুমতি রাখে না
404খুঁজে পাওয়া যায় নাঅনুরোধ করা সম্পদ বিদ্যমান নেই
429খুব অনেক অনুরোধহার সীমা অতিক্রম করা হয়েছে
500অভ্যন্তরীণ সার্ভার ত্রুটিসার্ভারে একটি অপ্রত্যাশিত ত্রুটি ঘটেছে
ত্রুটি প্রতিক্রিয়া
ত্রুটি প্রতিক্রিয়াগুলি সমস্যার বিবরণ সহ একটি JSON অবজেক্ট ফেরত দেয়:
{
"error": "Invalid API key",
"error_code": "INVALID_API_KEY",
"status": 401,
"timestamp": "2024-01-15T10:30:00Z"
}ত্রুটি কোডসমূহ
সাধারণ ত্রুটি কোড এবং তাদের অর্থ:
হার সীমিতকরণ
ফ্রস্টফয় এপিআই বিভিন্ন পরিকল্পনার জন্য বিভিন্ন হার সীমা প্রয়োগ করে। এটি নিশ্চিত করে যে সেবা সবার জন্য উপলব্ধ থাকে।
সীমা কিভাবে কাজ করে
হার সীমা সাধারণত প্রতি মিনিট বা ঘণ্টায় অনুরোধের সংখ্যা দ্বারা গণনা করা হয়। আপনি যখন সীমা অতিক্রম করেন, আমরা ৪২৯ স্ট্যাটাস কোড ফেরত পাঠাই।
HTTP/1.1 429 Too Many Requests
Retry-After: 60
পরিকল্পনা এবং সীমাসমূহ
| পরিকল্পনা | প্রতি মিনিটে | প্রতি দিনে |
|---|---|---|
| বিনামূল্যে | 10 | 1,000 |
| পেশাদার | 100 | 100,000 |
| এন্টারপ্রাইজ | অসীম | অসীম |
হার সীমা মোকাবেলা করা
যখন আপনি হার সীমায় আঘাত করেন:
- ১।Retry-After হেডার পড়ুন কতক্ষণ অপেক্ষা করতে হবে তা জানতে
- ২।এক্সপোনেনশিয়াল ব্যাকঅফ প্রয়োগ করুন পুনরায় চেষ্টা করার আগে
- ৩।একটি উচ্চতর পরিকল্পনায় আপগ্রেড করার বিবেচনা করুন
ওয়েবহুক
ওয়েবহুকগুলি আপনার সিস্টেমকে নির্দিষ্ট ঘটনা সম্পর্কে অবিলম্বে অবহিত করে। আপনার পছন্দের URL এ HTTP POST অনুরোধ পাঠানো হয়।
সমর্থিত ইভেন্টসমূহ
chat.message.created
একটি নতুন চ্যাট বার্তা তৈরি হয়েছে
chat.message.completed
একটি চ্যাট বার্তা প্রতিক্রিয়া সম্পূর্ণ হয়েছে
api.key.revoked
একটি এপিআই কী প্রত্যাহার করা হয়েছে
ওয়েবহুক পেলোড
সমস্ত ওয়েবহুক অনুরোধ একই JSON কাঠামো অনুসরণ করে:
{
"id": "wh_123456",
"event": "chat.message.created",
"data": {
"message_id": "msg_789",
"content": "হ্যালো, আপনি কিভাবে আছেন?",
"created_at": "2024-01-15T10:30:00Z"
},
"timestamp": "2024-01-15T10:30:00Z"
}ওয়েবহুক স্বাক্ষর যাচাই
প্রতিটি ওয়েবহুক অনুরোধ একটি স্বাক্ষর সহ স্বাক্ষরিত হয় যা আপনি যাচাই করতে পারেন:
X-Frostfoe-Signature: sha256=abc123def456
সেরা অনুশীলন
নিরাপত্তা
- ✓সর্বদা HTTPS ব্যবহার করুন এপিআই এন্ডপয়েন্টে
- ✓কখনও ক্লায়েন্ট-সাইড কোডে এপিআই কী প্রকাশ করবেন না
- ✓পরিবেশ পরিবর্তনশীলে এপিআই কী সংরক্ষণ করুন
- ✓নিয়মিত আপনার এপিআই কী রোটেট করুন
কর্মক্ষমতা
- ✓একাধিক অনুরোধ ব্যাচ করুন যেখানে সম্ভব
- ✓প্রতিক্রিয়া ক্যাশ করুন যখন উপযুক্ত
- ✓কানেকশন পুল ব্যবহার করুন দীর্ঘ-চলা সংযোগের জন্য
নির্ভরযোগ্যতা
- ✓এক্সপোনেনশিয়াল ব্যাকঅফের সাথে পুনরায় চেষ্টা করুন
- ✓Timeout সেট করুন দীর্ঘ-চলা অনুরোধে
- ✓ত্রুটি লগিং এবং মনিটরিং প্রয়োগ করুন