إنتقل إلى المحتوى الرئيسي

نظرة عامة على API المحلي

يوفر TikMatrix واجهة برمجة تطبيقات RESTful محلية تسمح لك بإدارة المهام برمجيًا. هذا مفيد لدمج TikMatrix في أنظمة الأتمتة الخاصة بك، أو بناء سير عمل مخصص، أو إنشاء عمليات دفعية.

المتطلبات​

متطلبات الترخيص

API المحلي متاح فقط لمستخدمي خطط Pro و Team و Business. لا توفر خطة Starter وصولاً إلى API.

عنوان URL الأساسي​

يعمل API محليًا على:

http://localhost:50809/api/v1/
ملاحظة

المنفذ 50809 هو المنفذ الافتراضي. يرجى التأكد من أن TikMatrix قيد التشغيل قبل إجراء الطلبات.

تنسيق الاستجابة​

تتبع جميع استجابات API التنسيق التالي:

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

توضيح رموز الاستجابة​

الرمزالوصف
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فشل تنفيذ المهمة

الخطوات التالية​