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

स्थानीय 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गलत अनुरोध - अमान्य पैरामीटर, जिसमें ऐसा script_config भी शामिल है जो सत्यापन में विफल हो
40002पैरामीटर त्रुटि - script_name गायब है
40003गलत अनुरोध - इस बिल्ड या प्लेटफ़ॉर्म पर स्क्रिप्ट समर्थित नहीं, कोई कार्यान्वयन नहीं, या टास्क की स्थिति अमान्य
40004पैरामीटर त्रुटि - केवल चल रहे कार्य को रोका जा सकता है
40005पैरामीटर त्रुटि - task_ids खाली नहीं हो सकता
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. स्क्रिप्ट और उनके पैरामीटर जानें​

GET /api/v1/schema बताता है कि यह बिल्ड कौन-कौन सी स्क्रिप्ट चला सकता है और हर एक script_config में कौन से फ़ील्ड लेता है — नाम, प्रकार, डिफ़ॉल्ट, स्वीकार्य मान, और कौन से अनिवार्य हैं। यह उसी कैटलॉग से बनता है जिससे सर्वर सत्यापन करता है, इसलिए यह टास्क बनाने में स्वीकार होने वाली चीज़ों से अलग नहीं हो सकता।

curl http://localhost:50809/api/v1/schema

दो वैकल्पिक क्वेरी पैरामीटर:

पैरामीटरप्रभाव
platformसूची को tiktok या instagram तक सीमित करता है। जो प्लेटफ़ॉर्म इस बिल्ड में नहीं है उसे 40001 के साथ अस्वीकार किया जाता है। डिफ़ॉल्ट रूप से बिल्ड के सभी प्लेटफ़ॉर्म।
include_unavailabletrue करने पर वे स्क्रिप्ट नाम भी सूचीबद्ध होते हैं जिन्हें API स्वीकार करता है पर जिनका कोई कार्यशील कार्यान्वयन नहीं है। हर एक के साथ unavailable_reason होता है।

प्रतिक्रिया (संक्षिप्त):

{
  "code": 0,
  "message": "success",
  "data": {
    "build": { "platforms": ["tiktok"] },
    "scripts": [
      {
        "name": "follow",
        "internal_name": "follow",
        "summary": "Follow the given users. One task per target.",
        "platforms": ["tiktok", "instagram"],
        "available": true,
        "fan_out": { "kind": "per_item", "key": "target_users", "alt_key": "target_user" },
        "any_of": [["target_users", "target_user"]],
        "fields": [
          {
            "key": "access_method",
            "type": "string",
            "required": false,
            "default": "direct",
            "choices": ["direct", "search"],
            "description": "How to reach the profile: direct (via URL) or search."
          }
        ]
      }
    ]
  }
}

fan_out बताता है कि एक अनुरोध कितने टास्क बनाएगा: per_device हर डिवाइस पर एक टास्क बनाता है (मल्टी-अकाउंट मोड में हर अकाउंट पर एक), और per_item बताए गए फ़ील्ड की हर प्रविष्टि के लिए, हर डिवाइस पर एक बनाता है।

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

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
  }'

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

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

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

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

स्क्रिप्ट नामविवरणAPI समर्थन
postसामग्री प्रकाशित करें✅ समर्थित
followउपयोगकर्ताओं को फ़ॉलो करें✅ समर्थित
unfollowअनफ़ॉलो करें✅ समर्थित
account_warmupखाता वार्मअप✅ समर्थित
commentटिप्पणी करें✅ समर्थित
boost_commentमौजूदा टिप्पणियों को लाइक/जवाब दें✅ समर्थित
loginखाते में लॉगिन करें✅ समर्थित
profileप्रोफ़ाइल अपडेट करें✅ समर्थित
match_accountडिवाइस पर खातों का मिलान करें✅ समर्थित
likeलाइक करें✅ समर्थित
viewएक निश्चित समय के लिए पोस्ट देखें✅ समर्थित
favoriteपोस्ट को पसंदीदा में सहेजें✅ समर्थित
repostTikTok वीडियो रीपोस्ट करें✅ समर्थित — केवल TikTok
messageसंदेश❌ उपलब्ध नहीं §
follow_suggestedसुझाए गए खातों को फ़ॉलो करें✅ समर्थित — केवल TikTok
super_marketingसुपर मार्केटिंग अभियान✅ समर्थित †
scrape_userउपयोगकर्ता डेटा स्क्रैप करें🔜 जल्द आ रहा है
† सुपर मार्केटिंग के लिए समर्पित एंडपॉइंट हैं

सुपर मार्केटिंग अभियान POST /api/v1/task के माध्यम से नहीं बनाया जाता। यह एक पुन: उपयोगी लक्ष्य डेटासेट पर चलता है और इसके अपने एंडपॉइंट हैं — देखें सुपर मार्केटिंग स्क्रिप्ट कॉन्फ़िगरेशन।

§ message का कोई कार्यान्वयन नहीं है

message को टास्क बनाते समय स्वीकार तो किया जाता था, पर स्क्रिप्ट बाइनरी में किसी भी प्लेटफ़ॉर्म के लिए इसका हैंडलर नहीं है, इसलिए ऐसा हर टास्क डिवाइस पर "Unknown script" के साथ विफल होता था। अब इसे बनाते समय ही उसी कारण के साथ अस्वीकार किया जाता है। डायरेक्ट मैसेज भेजने के लिए super_marketing का उपयोग करें, जो एक टारगेट डेटासेट के ज़रिए DM चलाता है।

प्लेटफ़ॉर्म-विशिष्ट स्क्रिप्ट

repost और follow_suggested केवल TikTok के लिए बने हैं। Instagram लक्ष्य पर इन्हें बनाने का अनुरोध कतार में जाने के बजाय अस्वीकार हो जाता है — पहले टास्क बन जाता था और फिर डिवाइस पर विफल होता था।

script_config सत्यापन​

टास्क बनाने से पहले script_config को ऊपर दिए स्कीमा से सत्यापित किया जाता है, ताकि गलत पैरामीटर बाद में फ़ोन पर विफल होने वाले टास्क के बजाय, फ़ील्ड का नाम बताने वाले 400 के रूप में लौटे। तीन चीज़ें अस्वीकार होती हैं:

  • कोई अनिवार्य फ़ील्ड जो गायब या खाली हो,
  • ऐसा विकल्प-समूह जिसमें कोई भी सदस्य सेट न हो (उदाहरण के लिए follow को target_users / target_user में से एक चाहिए),
  • किसी फ़ील्ड के प्रलेखित choices से बाहर का मान।

जो कुंजियाँ स्कीमा में नहीं हैं उन्हें अनदेखा किया जाता है, अस्वीकार नहीं — डेस्कटॉप ऐप स्वयं भी उसी ऑब्जेक्ट से अपनी कुंजियाँ भेजता है, और अनजान कुंजियाँ अस्वीकार करने से मौजूदा एकीकरण टूट जाते। उन्हें सर्वर पर लॉग किया जाता है ताकि आप ऐप लॉग में टाइपिंग की गलती पकड़ सकें।

संख्याएँ स्ट्रिंग के रूप में भी भेजी जा सकती हैं (20 के साथ-साथ "20" भी), जैसा स्क्रिप्ट पहले से स्वीकार करती हैं।

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

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

आगे​