मुख्य कंटेंट तक स्किप करें

स्थानीय API अवलोकन

TikMatrix एक स्थानीय RESTful API प्रदान करता है जो आपको कार्यों को प्रोग्रामेटिक रूप से प्रबंधित करने की अनुमति देता है। यह TikMatrix को अपने स्वयं के स्वचालन सिस्टम में एकीकृत करने, कस्टम वर्कफ़्लो बनाने या बैच संचालन करने के लिए उपयोगी है।

आवश्यकताएं​

लाइसेंस आवश्यकता

स्थानीय API केवल Pro, Team और Business योजना उपयोगकर्ताओं के लिए उपलब्ध है। Starter योजना API पहुंच प्रदान नहीं करती है।

बेस URL​

API स्थानीय रूप से चलता है, पता है:

http://localhost:50809/api/v1/
note

पोर्ट 50809 डिफ़ॉल्ट पोर्ट है। कृपया अनुरोध करने से पहले सुनिश्चित करें कि TikMatrix चल रहा है।

प्रतिक्रिया प्रारूप​

सभी API प्रतिक्रियाएं निम्नलिखित प्रारूप का पालन करती हैं:

{
  "code": 0,
  "message": "success",
  "data": { ... }
}

प्रतिक्रिया कोड विवरण​

Codeविवरण
0सफल
40001पैरामीटर त्रुटि - अमान्य अनुरोध पैरामीटर
40002पैरामीटर त्रुटि - script_name गायब है
40003पैरामीटर त्रुटि - स्क्रिप्ट फिलहाल API कॉल का समर्थन नहीं करती
40301निषिद्ध - API पहुंच के लिए Pro+ योजना की आवश्यकता है
40401नहीं मिला - संसाधन मौजूद नहीं है
50001सर्वर आंतरिक त्रुटि

त्वरित प्रारंभ​

1. API पहुंच की जांच करें​

सबसे पहले, पुष्टि करें कि आपका लाइसेंस API का समर्थन करता है:

curl http://localhost:50809/api/v1/license/check

नमूना प्रतिक्रिया:

{
  "code": 0,
  "message": "success",
  "data": {
    "plan_name": "Pro",
    "api_enabled": true,
    "device_limit": 20,
    "message": "API access enabled"
  }
}

2. कार्य बनाएं​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1", "device_serial_2"],
    "script_name": "post",
    "script_config": {
      "content_type": 1,
      "captions": "मेरा नया वीडियो देखें! #trending"
    },
    "enable_multi_account": false
  }'

3. कार्य सूची क्वेरी करें​

curl http://localhost:50809/api/v1/task?status=0&page=1&page_size=20

उपलब्ध स्क्रिप्ट​

वर्तमान समर्थन

वर्तमान में, स्थानीय API post, follow, unfollow, account_warmup और comment स्क्रिप्ट का समर्थन करता है। भविष्य के संस्करणों में अधिक स्क्रिप्ट जोड़ी जाएंगी।

script_name पैरामीटर निम्नलिखित मान स्वीकार करता है:

स्क्रिप्ट नामविवरणAPI समर्थन
postसामग्री प्रकाशित करें✅ समर्थित
followउपयोगकर्ताओं को फ़ॉलो करें✅ समर्थित
unfollowअनफ़ॉलो करें✅ समर्थित
account_warmupखाता वार्मअप✅ समर्थित
commentटिप्पणी करें✅ समर्थित
likeलाइक करें🔜 जल्द आ रहा है
messageसंदेश🔜 जल्द आ रहा है
super_marketingसुपर मार्केटिंग अभियान🔜 जल्द आ रहा है
profileप्रोफ़ाइल अपडेट करें🔜 जल्द आ रहा है
scrape_userउपयोगकर्ता डेटा स्क्रैप करें🔜 जल्द आ रहा है

कार्य स्थिति​

स्थिति कोडस्थिति टेक्स्टविवरण
0pendingकार्य निष्पादन की प्रतीक्षा में
1runningकार्य निष्पादित हो रहा है
2completedकार्य सफलतापूर्वक निष्पादित
3failedकार्य निष्पादन विफल

आगे​