Ana içeriğe geç

Yerel API Genel Bakış

Komut dosyası güncellemesi\nPro'daki Threads message, follow_back, scrape_users ve repost'u destekler; post içindeki content_type = 2 yalnızca metin gönderisidir. TikTok/Instagram'da bağımsız message yoktur; Super Marketing kullanın.\n:::

TikMatrix, görevleri programatik olarak yönetmenizi sağlayan yerel bir RESTful API sunar. Bu, TikMatrix'i kendi otomasyon sistemlerinizle entegre etmek, özel iş akışları oluşturmak veya toplu işlemler gerçekleştirmek için kullanışlıdır.

Gereksinimler​

Lisans Gereksinimi

Yerel API yalnızca Pro, Team ve Business plan abonelerine açıktır. Starter plan API erişimine sahip değildir.

Temel URL​

API yerel makinenizde çalışır:

http://localhost:50809/api/v1/
not

50809 varsayılan porttur. API istekleri göndermeden önce TikMatrix'in çalıştığından emin olun.

Yanıt Formatı​

Tüm API yanıtları şu formatı takip eder:

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

Yanıt Kodları​

CodeAçıklama
0Başarılı
40001Hatalı İstek - Geçersiz parametreler; doğrulamadan geçemeyen bir script_config dahil
40002Hatalı İstek - script_name eksik
40003Hatalı İstek - Betik bu derlemede veya bu platformda desteklenmiyor, uygulaması yok ya da görev durumu geçersiz
40004Hatalı İstek - Yalnızca çalışan görevler durdurulabilir
40005Hatalı İstek - task_ids boş olamaz
40301Yasak - API erişimi Pro+ planı gerektirir
40401Bulunamadı - Kaynak bulunamadı
50001Dahili Sunucu Hatası

Hızlı Başlangıç​

1. API Erişimini Kontrol Et​

Önce lisansınızın API erişimini destekleyip desteklemediğini doğrulayın:

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

Yanıt:

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

2. Betikleri ve parametrelerini keşfetme​

GET /api/v1/schema, bu derlemenin çalıştırabildiği her betiği ve her birinin aldığı script_config alanlarını tam olarak açıklar: adlar, türler, varsayılanlar, izin verilen değerler ve hangilerinin zorunlu olduğu. Sunucunun doğrulama için kullandığı katalogdan üretildiği için görev oluşturmanın kabul ettiğinden sapamaz.

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

İki isteğe bağlı sorgu parametresi:

ParametreEtkisi
platformListeyi tiktok, instagram veya threads ile sınırlar. Bu derlemede bulunmayan bir platform 40001 ile reddedilir. Varsayılan olarak derlemedeki tüm platformlar.
include_unavailabletrue yapıldığında, API’nin kabul ettiği ama çalışan bir uygulaması olmayan betik adlarını da listeler. Her biri bir unavailable_reason taşır.

Yanıt (kısaltılmış):

{
  "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", "threads"],
        "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, bir isteğin kaç görev üreteceğini söyler: per_device cihaz başına bir görev oluşturur (çoklu hesap modunda hesap başına), per_item ise belirtilen alanın her girdisi için cihaz başına bir görev oluşturur.

3. Görev Oluştur​

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": "Yeni videoma göz at! #viral"
    },
    "enable_multi_account": false,
    "start_time": "14:30"
  }'

4. Görevleri Listele​

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

Mevcut Skriptler​

script_name parametresi aşağıdaki değerleri kabul eder:

Script AdıAçıklamaAPI Desteği
postVideo, görsel veya yalnızca metin içeren Threads gönderilerini yayınla✅ Destekleniyor
followKullanıcıları takip et✅ Destekleniyor
unfollowKullanıcıların takibini bırak✅ Destekleniyor
account_warmupHesapları ısıt✅ Destekleniyor
commentGönderilere yeni yorum yap✅ Destekleniyor
boost_commentMevcut yorumları beğen / yanıtla✅ Destekleniyor
loginHesaba giriş yap✅ Destekleniyor
profileProfili güncelle✅ Destekleniyor
match_accountCihazdaki hesapları eşleştir✅ Destekleniyor
likeGönderileri beğen✅ Destekleniyor
viewBir gönderiyi belirli bir süre izle✅ Destekleniyor
favoriteGönderiyi Favorilere kaydet✅ Destekleniyor
repostTikTok videolarını veya Threads gönderilerini yeniden paylaş✅ Destekleniyor — TikTok ve Threads
messageDoğrudan mesaj gönder✅ Destekleniyor — yalnızca Threads
follow_backTakipçi listesindeki hesapları takip et✅ Destekleniyor — TikTok, Instagram ve Threads
follow_suggestedÖnerilen hesapları takip et✅ Destekleniyor — yalnızca TikTok
custom_scriptKendi kaydettiğiniz bir programı çalıştır✅ Destekleniyor ‡
super_marketingSüper pazarlama kampanyası✅ Destekleniyor †
scrape_usersTakipçi, takip edilen veya arama sonucu kullanıcı adlarını dışa aktar✅ Destekleniyor — TikTok, Instagram ve Threads
auto_replyDoğrudan mesajlara ve yorumlara yanıt ver❌ API üzerinden kullanılamaz §
† Süper marketing özel endpoint'ler kullanır

Süper pazarlama kampanyası POST /api/v1/task üzerinden oluşturulmaz. Yeniden kullanılabilir bir hedef veri kümesi üzerinde çalışır ve kendi özel endpoint'lerine sahiptir — bkz. Süper Marketing Skript Yapılandırması.

Yalnızca Threads için doğrudan mesajlaşma

Bağımsız message görevi, Threads profili → Mesaj akışını yürütür. TikTok ve Instagram için bunun yerine hedef veri kümesiyle super_marketing kullanın.

Platforma özgü betikler

repost TikTok ve Threads için uygulanmıştır; follow_suggested ise yalnızca TikTok için kalmaya devam eder. follow_back ve scrape_users, her platformun gerçek cihazdaki takipçi/arama arayüzünü kullanır ve TikTok, Instagram ve Threads'te kullanılabilir.

‡ Özel betikler önce kaydedilmelidir

custom_script, Cihazlar → Özel Betikler altında kaydettiğiniz bir programı çalıştırır. Kimliğini script_config.custom_script_id alanına geçirin — bkz. Özel Betikler.

§ Otomatik yanıt kendi sayfasından çalışır

auto_reply, Pro planı ve üzeri için TikTok, Instagram ve Threads'te doğrudan mesajlara ve yorumlara yanıt verir. Yanıt turları uygulamadaki Otomatik yanıt sayfası tarafından planlanır; yanıt kuralları, çalışma saatleri ve duraklatma anahtarı bu sayfada tutulduğu için POST /api/v1/task ile oluşturulamaz.

script_config doğrulaması​

Görev oluşturma, herhangi bir şey yazmadan önce script_config’i yukarıdaki şemaya göre doğrular; böylece hatalı bir parametre, telefonda sonradan başarısız olan bir görev yerine, alanı adlandıran bir 400 olarak geri döner. Üç şey reddedilir:

  • eksik veya boş bırakılmış zorunlu bir alan,
  • hiçbir üyesi ayarlanmamış bir "şunlardan biri" grubu (örneğin follow, target_users / target_user alanlarından birine ihtiyaç duyar),
  • bir alanın belgelenmiş choices değerleri dışında bir değer.

Şemada yer almayan anahtarlar reddedilmez, yok sayılır — masaüstü uygulaması kendi anahtarlarını aynı nesneden geçirir ve bilinmeyen anahtarları reddetmek mevcut entegrasyonları bozardı. Sunucu tarafında günlüklenir, böylece bir yazım hatasını uygulama günlüğünde fark edebilirsiniz.

Sayılar dizge olarak da gönderilebilir (20 kadar "20" de olur); betiklerin zaten kabul ettiği biçimle uyumludur.

Görev Durumu​

Durum KoduDurum MetniAçıklama
0pendingGörev yürütülmeyi bekliyor
1runningGörev şu anda çalışıyor
2completedGörev başarıyla tamamlandı
3failedGörev başarısız oldu

Sonraki Adımlar​