tsboost.com API আপনাকে আমাদের প্ল্যাটফর্মের বিভিন্ন ফিচার এবং ডেটা আপনার নিজস্ব অ্যাপ্লিকেশন বা সিস্টেমে একীভূত করার সুযোগ দেয়। এই ডকুমেন্টেশন আপনাকে API ব্যবহারের জন্য প্রয়োজনীয় সকল তথ্য সরবরাহ করবে।
অনুগ্রহ করে মনে রাখবেন, API ব্যবহারের জন্য আপনার একটি সক্রিয় tsboost.com অ্যাকাউন্ট এবং একটি API Key প্রয়োজন হবে।
১. শুরু করার আগে (Getting Started)
বেস URL:
https://api.tsboost.com/v1/
অথেনটিকেশন (Authentication):
আমাদের API ব্যবহার করার জন্য আপনার প্রতিটি অনুরোধে একটি বৈধ API Key অন্তর্ভুক্ত করতে হবে। API Key টি আপনার অ্যাকাউন্ট ড্যাশবোর্ড থেকে তৈরি করা যাবে।
API Key টি রিকোয়েস্ট হেডারে `X-API-KEY` হিসেবে পাঠাতে হবে।
Header:
X-API-KEY: your_api_key_here
২. উপলব্ধ এন্ডপয়েন্টস (Available Endpoints)
আমাদের API নিম্নলিখিত এন্ডপয়েন্টগুলি অফার করে। প্রতিটি এন্ডপয়েন্টের জন্য প্রয়োজনীয় প্যারামিটার এবং প্রত্যাশিত প্রতিক্রিয়া (Response) নিচে দেওয়া হলো:
✔ ব্যবহারকারীর প্রোফাইল তথ্য (Get User Profile)
একটি নির্দিষ্ট ব্যবহারকারীর প্রোফাইল ডেটা পুনরুদ্ধার করুন।
HTTP Method: GET
Endpoint: /user/{user_id}/profile
প্যারামিটার (Parameters):
- `user_id` (path): (সংখ্যা) ব্যবহারকারীর আইডি। (আবশ্যক)
উদাহরণ অনুরোধ (Example Request):
GET https://api.tsboost.com/v1/user/123/profile
Header:
X-API-KEY: your_api_key_here
প্রত্যাশিত প্রতিক্রিয়া (Example Response):
{
"status": "success",
"data": {
"user_id": 123,
"username": "example_user",
"email": "user@example.com",
"balance": 150.75,
"member_since": "2023-01-15"
}
}
✔ উপলব্ধ মাইক্রো-জব (Get Available Micro-Jobs)
বর্তমানে উপলব্ধ সকল মাইক্রো-জবের তালিকা পান।
HTTP Method: GET
Endpoint: /jobs/available
প্যারামিটার (Parameters):
- `category` (query): (ঐচ্ছিক) ক্যাটাগরি অনুযায়ী ফিল্টার করুন।
- `limit` (query): (ঐচ্ছিক) প্রতি পৃষ্ঠায় ফলাফলের সংখ্যা (ডিফল্ট: 10)।
উদাহরণ অনুরোধ (Example Request):
GET https://api.tsboost.com/v1/jobs/available?
category=social_media&limit=5
Header:
X-API-KEY: your_api_key_here
প্রত্যাশিত প্রতিক্রিয়া (Example Response):
{
"status": "success",
"data": [
{
"job_id": 101,
"title": "YouTube Video Like",
"reward": 0.05,
"category": "social_media"
},
{
"job_id": 102,
"title": "Facebook Page Follow",
"reward": 0.03,
"category": "social_media"
}
]
}
৩. ত্রুটি প্রতিক্রিয়া (Error Responses)
API অনুরোধ ব্যর্থ হলে, আপনি একটি ত্রুটি প্রতিক্রিয়া পাবেন যা সমস্যার প্রকৃতি ব্যাখ্যা করবে:
উদাহরণ: অবৈধ API Key
HTTP Status: 401 Unauthorized
{
"status": "error",
"message": "Invalid API Key"
}
উদাহরণ: অবৈধ প্যারামিটার
HTTP Status: 400 Bad Request
{
"status": "error",
"message": "Missing or invalid parameter: user_id"
}
৪. রেট লিমিটিং (Rate Limiting)
আমাদের API তে অনাকাঙ্ক্ষিত লোড এড়াতে রেট লিমিটিং প্রযোজ্য। সাধারণত, প্রতি মিনিটে ৩০টি অনুরোধ অনুমোদিত। সীমা অতিক্রম করলে আপনি `429 Too Many Requests` স্ট্যাটাস কোড পাবেন।
৫. সাপোর্ট
API সম্পর্কিত আপনার কোনো প্রশ্ন বা সমস্যা থাকলে, অনুগ্রহ করে আমাদের সাপোর্ট টিমের সাথে যোগাযোগ করুন।