Belgeler
Ctrl+K Arama Alt+[Alt+] Kılavuzlar
API anahtarını al

Kılavuzlar

Kimlik Doğrulama

Her bir ölçümlü programatik uç nokta, üç yoldan biriyle gönderilen tek bir API anahtarı kabul eder. Bu sayfada, anahtarı nereden alacağınız, nasıl göndereceğiniz ve sunucunun bunu hesabınızla nasıl ilişkilendireceği anlatılmaktadır.

Anahtarınızı gönderiyorum

Sunucu, bu sırayla üç konumu kontrol eder. İlk boş olmayan değer geçerli sayılır.

Nerede Örnek Notlar
X-API-Anahtarı başlık X-API-Key: wh_… Tercih edilen. Büyük/küçük harfe duyarlı olmayan başlık adı.
Yetkilendirme başlık Yetki: Taşıyıcı wh_… Standart Taşıyıcı programı. Diğer her şey (örn. Temel) göz ardı edilir.
api_key sorgu parametresi ?api_key=wh_… Yalnızca yedek amaçlıdır. Hassas bilgiler için kullanmaktan kaçının — bu bilgiler URL’lerde, sunucu günlüklerinde ve tarayıcı geçmişinde yer alır. 
curl -sS \
  -H "X-API-Key: $WH_API_KEY" \
  "{origin}/api/v1/tiktok-shop/credits"

curl -sS \
  -H "Authorization: Bearer $WH_API_KEY" \
  "{origin}/api/v1/tiktok-shop/credits"

curl -sS "{origin}/api/v1/tiktok-shop/credits?api_key=$WH_API_KEY"

Üçü de yönlendirme açısından birbirinin aynısıdır; HTTP istemcinizde hangisi daha kolaysa onu seçin.

Anahtarın kaynağı

Anahtarlar yalnızca uygulama içi API sayfasından yönetilir:

  • GET /api — mevcut anahtarınızı görüntüleyin, kopyalayın, yeniden oluşturun.
  • POST /api/regenerate — programlı yenileme (oturum açılması gerekir).

Bir anahtar şuna benzer wh_ ardından 48 onaltılık karakter gelir. Bunu bir şifre gibi düşünün: bu, tüm aylık API kotası.

Yenilenme ani ve yıkıcı. Yeniden oluşturma işlemi yapıldığı anda önceki anahtar çalışmaz hale gelir ve onu hâlâ kullanan tüm istemciler 401 Yetkisiz. Ne zaman döndürülmeli:

  • Bir sızıntı olduğundan şüpheleniyorsunuz.
  • Erişim yetkisi olan bir ekip üyesi veya yüklenici işten ayrılır.
  • Yanlışlıkla bir anahtarı sürüm kontrolüne eklediniz.

Aksi belirtilmedikçe anahtarların geçerlilik süresi yoktur — siz anahtarı yenilemediğiniz veya planınızın seviyesi düşürülmediği sürece çalışmaya devam ederler.

Plan

Bir anahtar bir hesaba eşleştirildiğinde, sunucu o hesap için API erişiminin etkin olup olmadığını kontrol eder. Etkin değilse, anahtar biçimi geçerli olsa bile HTTP 403 hatası alırsınız. Plan indirgemeleri veya iptaller, erişimi anında kaldırabilir.

Takım ve kuruluş

Anahtarlar kullanıcı başına verilir. Takım yapılandırmalarında, kullanım ve erişim, ürün içindeki kuruluşunuzun faturalandırma kurallarına tabidir; lisansınızla ilgili kesin bilgileri görmek için uygulama içi API sayfasını ve kontrol panelini kullanın.

Oturum ve API anahtarı

WinningHunter rotaları üç türe ayrılır. Doğru rotadan bahsettiğinizden emin olun.

Yol öneki Yazar Ne zaman kullanılır
/api/v1/tiktok-shop/* API anahtarı (X-API-Anahtarı) Tüm programatik / harici entegrasyonlar. Kredi limitinden ve istek sınırından geçer.
/api/tiktok-shop/*, /api/ürün-detayı/*vb. Oturum açılmış tarayıcı oturumu (çerezler) Yalnızca web uygulaması tarafından kullanılır. Bunlar değil API anahtarı alanı — kullan /api/v1/tiktok-shop/* entegrasyonlar için.
/api/v1/adlibrary, /api/v1/magic-ai, /api/v1/mağaza-izleyici, /api/v1/mağaza-keşif, /api/v1/markalar API anahtarı TikTok dışındaki programatik platform. Ölçüm yöntemi aynıdır /api/v1/tiktok-shop/*. Sürüm numarası belirtilmemiş /api/<x> formlar, aşağıya doğru uyumlu takma adlar olarak tutulur reklam kütüphanesi, mağaza takipçisive mağaza gezgini sadece — yeni entegrasyonlar v1 yollarını çağırmalıdır. /api/magic-ai ve /api/markalar (hayır v1) şunlardır kontrol paneli oturum yolları, API anahtarı alanı değil; çünkü kontrol paneli sayfaları bu URL’lere hâlâ POST/GET istekleri gönderiyor; anahtar istemcileri /api/v1/magic-ai ve /api/v1/markalar.

Bir komut dosyası veya arka uç entegrasyonu yazıyorsanız, neredeyse her zaman /api/v1/tiktok-shop/... ayrıca yukarıdaki TikTok dışı birkaç yol. Tüm yüzey, API kılavuzu ve konu kılavuzları (TikTok Shop, Meta reklam kütüphanesi, Markalar vb.).

Anahtarın doğrulama#

Duman testi yapmanın en ucuz yolu şudur: GET /api/v1/tiktok-shop/credits — mevcut kredi bakiyesini gösterir ve 1 kredi tutarındadır:

curl -i \
  -H "X-API-Key: $WH_API_KEY" \
  "{origin}/api/v1/tiktok-shop/credits"

A 200 JSON ile şu anlama gelir: anahtar geçerli, plan uygun, hız sınırı ve kredilerde sorun yok. Diğer durumlar için bkz. Hatalar.

Güvenlik

  • Anahtarları ortam değişkenlerinde veya güvenli bir kimlik bilgisi deposunda saklayın — asla istemci tarafındaki kodda, mobil uygulamalarda veya tarayıcı paketlerinde saklamayın.
  • Kullanım X-API-Anahtarı ya da Yetki: Taşıyıcı, mümkün olduğunca sorgu parametresi yerine.
  • Herhangi bir olayın ardından, ekip üyeliğinde bir değişiklik olduğunda ve yılda en az bir kez.
  • Anahtarları farklı ortamlar arasında paylaşmayın — her hizmet hesabı için ayrı bir anahtar oluşturun ve bunları bağımsız olarak değiştirin.