API belgeleri

action=services

Sipariş verebileceğiniz tüm siteleri, güncel oranları ve sınırlarıyla listeler. add çağrılarınızda `service` kimliğini kullanın.

curl -X POST https://backend.toplistbot.com/api/v2 \
  -d "key=YOUR_API_KEY" \
  -d "action=services"

[
  {
    "service": 9,
    "name": "arena-top100.com 1000 upvotes",
    "type": "Default",
    "category": "Votes",
    "rate": 15,
    "min": 1,
    "max": 50000,
    "refill": false,
    "cancel": true
  }
]

`rate`, 1.000 işlem başına jetondur. Her hizmet için `min` 1, `max` 50000'dir.

action=add

Bir kampanya oluşturur ve ücretini bakiyenizden anında düşer.

curl -X POST https://backend.toplistbot.com/api/v2 \
  -d "key=YOUR_API_KEY" \
  -d "action=add" \
  -d "service=9" \
  -d "link=https://arena-top100.com/index.php?a=in&u=yourserver" \
  -d "quantity=1000" \
  -d "interval=60"

{
  "order_id": 184223
}

action=status

Bir veya daha fazla siparişin ilerlemesini döndürür. Düz bir nesne için tek kimlik, ya da virgülle ayrılmış bir liste gönderin.

curl -X POST https://backend.toplistbot.com/api/v2 \
  -d "key=YOUR_API_KEY" \
  -d "action=status" \
  -d "orders=184223"

{
  "charge": 13.5,
  "start_count": 0,
  "status": "Completed",
  "remains": 1000,
  "currency": "USD"
}

Birden fazla kimlikte yanıt sipariş kimliğine göre anahtarlanır; bilinmeyen veya size ait olmayan siparişler tüm isteği başarısız kılmak yerine bir hata kaydı döndürür.

{
  "184223": { "charge": 13.5, "start_count": 0, "status": "Completed", "remains": 1000, "currency": "USD" },
  "184224": { "error": "Incorrect order ID" }
}

`status` ve `cancel` çağrı başına en fazla 100 sipariş kimliği kabul eder. Döngü kurmak yerine toplu gönderin: 100 kimlikli tek çağrı, iki taraf için de 100 çağrıdan çok daha ucuzdur.

action=balance

Kalan jeton bakiyenizi döndürür.

curl -X POST https://backend.toplistbot.com/api/v2 \
  -d "key=YOUR_API_KEY" \
  -d "action=balance"

{
  "balance": 528.41,
  "currency": "USD"
}

action=cancel

Bir siparişi durdurur ve harcanmayan kalanı bakiyenize iade eder. Tamamlanmış siparişler iptal edilemez.

curl -X POST https://backend.toplistbot.com/api/v2 \
  -d "key=YOUR_API_KEY" \
  -d "action=cancel" \
  -d "orders=184223,184224"

[
  { "order": "184223", "cancel": 1, "refund": 4.5 },
  { "order": "184224", "cancel": { "error": "Incorrect order ID" } }
]

Katalog ve keşif#

Herkese açık, kimlik bilgisi gerekmez. Başlanacak uç nokta getAllWebsites: bir siparişi fiyatlandırmak ve boyutlandırmak için gereken kimlik, fiyat, saatlik tavan ve kabul oranını taşır.

• GET/orders/getAllWebsitesHerkese açıkTüm katalog: her site, ücretleri, limitleri ve üst verileriyle
• GET/orders/getAllBasicWebsitesDetailsHerkese açıkRastgele 20 site adı; bileşenler ve otomatik tamamlama için
• POST/orders/getWebsiteDetailsByNameHerkese açıkTam ada göre tek site
• POST/products/getSuggestionsHerkese açıkBir kimlik kümesiyle ilişkili siteler
• GET/products/demand?days=30Herkese açıkHer sitenin son dönemde ne kadar sipariş aldığı
• GET/products/tokensHerkese açıkSatın alabileceğiniz token paketleri
• POST/products/suggestAPI anahtarıYeni bir site eklememizi isteyin
• GET/api/news/timelineHerkese açıkÜrün değişiklik günlüğü

curl "https://backend.toplistbot.com/orders/getAllWebsites"

Daha azını isteyin

Katalogun tamamı 396 site için yaklaşık 665 KB tutar ve bunun yarısını asla sipariş vermeyeceğiniz iki alan oluşturur: saklanan bir popülerlik JSON bloğu ve pazarlama açıklaması. Yalnızca sipariş verirken kullandığınız alanlara indirip pasif siteleri eleyince yaklaşık 40 KB'a düşer.

# The whole catalog is ~665 KB across 396 sites.
# Projected to what you actually order with: ~40 KB.
curl -s "https://backend.toplistbot.com/orders/getAllWebsites" \
  | jq '[.[]
      | select(.active == 1)
      | {id, name, price_per_1000, max_per_hour, accept_rate, subscribeable}]'

Hesap ve oturumlar#

Kayıt için tarayıcı gerekir: bir Cloudflare doğrulamasıyla korunur. app.toplistbot.com üzerinden bir kez kayıt olun, sonrasındaki her şeyi otomatikleştirin.

• POST/api/auth/registerHerkese açıkHesap oluştur: yalnızca tarayıcıdan, captcha korumalı
• POST/api/auth/loginHerkese açıkKimlik bilgilerini JWT ile değiştir
• POST/api/auth/refreshJWTSüresi dolan bir JWT'den yenisini üret
• POST/api/auth/logoutJWTGeçerli JWT'yi geçersiz kıl
• GET/api/auth/user-profileJWTOturum açmış hesap; bakiye ve API anahtarıyla
• GET/api/userJWTAynı kullanıcı nesnesi, daha kısa bir yolda
• GET/api/api_tokenAPI anahtarıBir API anahtarını sahibine çöz: anahtar doğrulamak için kullanın
• POST/api/auth/reset-api-keyJWTAPI anahtarını döndür; eskisi anında ölür
• POST/api/auth/fingerprintJWTHesaba bir tarayıcı parmak izi kaydet
• POST/api/auth/ipJWTHesabın güncel IP'sini kaydet
• POST/api/auth/forgot-passwordHerkese açık60 dakika geçerli bir sıfırlama bağlantısı gönder
• POST/api/auth/reset-passwordHerkese açıkE-postayla gelen token ile yeni parola belirle

İki adımlı doğrulama ve giriş#

İki adımlı doğrulama parola girişini korur. API anahtarları için geçerli değildir; gözetimsiz işler için anahtarın daha iyi bir kimlik bilgisi olmasının nedeni budur.

• POST/api/2fa/enableJWTKaydı başlat: gizli anahtarı, QR adresini ve kurtarma kodlarını döner
• POST/api/2fa/verifyJWTAltı haneli kodu doğrula ve iki adımlı doğrulamayı aç
• POST/api/2fa/disableJWTİki adımlı doğrulamayı kapat
• POST/api/account/verification/requestJWTOturum açmış adrese doğrulama bağlantısı gönder
• GET/api/account/verification/confirm?token=Herkese açıkOnay sayfasını göster: hiçbir şey yazmaz
• POST/api/account/verification/confirmHerkese açıkDoğrulamayı tamamla
• GET/api/auth/googleHerkese açıkGoogle ile girişi başlat
• GET/api/auth/google/callbackHerkese açıkGoogle giriş dönüşü
• GET/api/auth/discordHerkese açıkDiscord ile girişi başlat
• GET/api/auth/discord/callbackHerkese açıkDiscord giriş dönüşü

Tercihler ve uyarılar#

E-posta ve bildirim anahtarları ile hesabın uyarı akışı.

• GET/api/user/email-preferencesJWTPazarlama e-postası aboneliği durumu
• POST/api/user/email-preferencesJWTDeğiştir
• GET/api/user/notification-preferencesJWTCanlı oy bildirimi tercihi
• POST/api/user/notification-preferencesJWTDeğiştir: gerçek bir JSON boolean olmalı
• GET/api/user/alerts?limit=20JWTHesap uyarıları, en yeniden başlayarak, ?before ile sayfalanır
• POST/api/user/alerts/readJWTBir uyarıyı okundu işaretle
• POST/api/user/alerts/dismissJWTBir uyarıyı kapat
• GET/api/email/unsubscribe?token=Herkese açıkE-postayla gelen tokenla tek tıkla abonelikten çık

Kampanyalar#

Kampanya oluşturun, çalışırken yönlendirin ve sonlandırın. Platform API'sinin çekirdeği burasıdır.

• GET/orders/getAllAPI anahtarıKampanyalarınız, en yeniden başlayarak, siteleriyle birlikte
• GET/orders/get/{id}API anahtarıTek kampanya
• POST/orders/checkoutAPI anahtarıKampanya oluştur ve bakiyeden düş
• POST/orders/updateAPI anahtarıBir kampanyayı düzenle
• POST/orders/pauseAPI anahtarıÇalışan bir kampanyayı duraklat
• POST/orders/unpauseAPI anahtarıDuraklatılmış kampanyayı sürdür
• POST/orders/archiveAPI anahtarıBir kampanyayı arşivle
• POST/orders/unarchiveAPI anahtarıArşivlenmiş kampanyayı geri getir
• PATCH/orders/updateLimitAPI anahtarıGünlük oy tavanını ayarla veya kaldır

POST /orders/checkout

Gövde en üst düzeyde bir JSON dizisidir, nesne değil. Her satır bir kampanyadır. Hiçbir tahsilat yapılmadan önce sepetin tamamı doğrulanır ve tahsilat ile eklemeler tek işlemdir: sipariş ya tümüyle olur ya da hiç olmaz.

Sabit adetli satır

Olağan durum: bir adrese belirli sayıda oy teslim etmek.

curl -X POST "https://backend.toplistbot.com/orders/checkout?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "id": 9,
      "amount": 1000,
      "ownName": "https://arena-top100.com/index.php?a=in&u=yourserver",
      "custom_max_per_hour": 60
    }
  ]'

200 OK
Successfully purchased with token balance

Abonelik satırı

`subscribeable` göstergesi 1 olan siteler için. Fiyat, sitenin subscription_price_1d değerinin gün sayısı ve kademe indirimiyle çarpımıdır: Weekly 0,90, Monthly 0,80, diğer her şey 1,00. Teslim edilecek miktar sunucuda sitenin kendi subscription_speed değerinden türetilir, yani gönderdiğiniz hiçbir şey onu değiştirmez.

[
  {
    "type": "subscription",
    "website": { "id": 9 },
    "subscription_days": 30,
    "tier": { "name": "Monthly" },
    "url": "https://arena-top100.com/index.php?a=in&u=yourserver"
  }
]

Yanıtlar

• 200Bütün satırlar oluşturuldu ve bakiyeden düşüldü. Gövde düz metindir.
• 400Gövde geçerli JSON değildi.
• 402Token yetersiz. Mesaj kaç token gerektiğini söyler ve hiçbir tahsilat yapılmaz.
• 422Bir veya daha fazla satır hatalı. Hiçbir tahsilat yapılmadı.
• 429Aynı sepet son 60 saniye içinde gönderildi. Belirtilen süre sonra yeniden deneyin.

422 yanıtı sorunlu satırı adlandırır: hatalar items.[index].[field] biçiminde anahtarlanır, böylece üç hatalı satırı olan bir sepet üç turda değil tek turda düzeltilir.

{
  "errors": {
    "items.2.amount": ["Enter 0 or more votes; a negative amount is not allowed."]
  }
}

POST /orders/update

`id` zorunludur; yalnızca değiştirdiğiniz alanları gönderin. Abonelik siparişleri değiştirilemez.

curl -X POST "https://backend.toplistbot.com/orders/update?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":184223,"amount_to_do":2000,"custom_name":"EU launch"}'

Günlük tavan

`type: "delete"` tavanı kaldırır. Bu durumda da doğrulayıcı `max_votes_per_day` ister: herhangi bir tam sayı gönderin.

curl -X PATCH "https://backend.toplistbot.com/orders/updateLimit?key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":184223,"max_votes_per_day":500,"type":"set"}'

Kayıtlar ve analizler#

Oy oy ve toplu teslimat verileri. Ayrı bir kayıt veritabanını okurlar ve API'nin geri kalanından yavaştırlar: saniyede değil, dakikada bir sorgulayın.

• GET/orders/logs/{id}API anahtarıBir kampanyanın oy oy teslimat kaydı
• GET/orders/graph/{id}API anahtarıTek kampanya için grafiğe hazır zaman serisi
• GET/api/orders/graph/summaryJWTTüm kampanyalarınızı kapsayan tek seri
• GET/orders/grouped/usernames/{id}API anahtarıOy veren kullanıcı adına göre gruplanmış teslimatlar
• POST/orders/averageAPI anahtarıBirden çok kampanyanın ortalama teslimatı
• GET/api/logs/{id}/filtered-graphJWTFiltrelenmiş zaman serisi

Oy ve proxy profilleri#

Oy profili, bir kampanyanın oy verirken kullandığı adlandırılmış kullanıcı adı listesidir. Proxy profili ise kullanılan IP'ler için ülke izin listesidir. İkisini de /orders/update üzerinden username_profile_id veya proxy_profile_id ile bir kampanyaya bağlayın.

• GET/advanced/profile/getAPI anahtarıOy profilleriniz
• GET/advanced/profile/get/{id}API anahtarıTek oy profili
• POST/advanced/profile/createAPI anahtarıOy profili oluştur veya kimliğe göre üzerine yaz
• DELETE/advanced/profile/delete/{id}API anahtarıBir oy profilini sil
• GET/advanced/profile/proxy/getAPI anahtarıProxy profilleriniz
• GET/advanced/profile/proxy/get/{id}API anahtarıTek proxy profili
• POST/advanced/profile/proxy/createAPI anahtarıProxy profili oluştur veya kimliğe göre üzerine yaz
• DELETE/advanced/profile/proxy/delete/{id}API anahtarıBir proxy profilini sil

Discord tokenları#

Oy verenleri Discord üzerinden doğrulayan listeler için. Aynı token iki kez eklenirse yinelenmiş sayılıp reddedilir.

• GET/api/discord-tokensJWTDiscord tokenlarınız
• POST/api/discord-tokensJWTToken ekle
• GET/api/discord-tokens/statsJWTTokenlarınızın toplam kullanımı
• GET/api/discord-tokens/{id}JWTTek token
• PATCH/api/discord-tokens/{id}JWTBir tokenı veya etkin durumunu değiştir
• DELETE/api/discord-tokens/{id}JWTBir tokenı kaldır
• PUT/api/discord-tokens/{id}/toggleJWTBir tokenı etkin ve devre dışı arasında çevir

Faturalama ve ödemeler#

Token satın alma her zaman barındırılan bir ödeme sayfasında biter, bu yüzden bakiye yükleme tamamen otomatik olamaz. Yüklemeden sonrası olabilir.

• GET/invoices/getAPI anahtarıFaturalama geçmişi
• GET/api/subscriptions/subscriptionsJWTEtkin abonelikler
• GET/products/tokensByUserAPI anahtarıHesabınıza göre fiyatlanmış token paketleri
• POST/company/getAPI anahtarıFatura adresiniz
• POST/company/createAPI anahtarıAdresi ayarla: country, region, city, address, postalCode
• GET/api/stripe/checkout?product_id=JWTToken paketi için Stripe Checkout adresi
• GET/api/stripe/subscription?plan=JWTBir plan için Stripe Checkout adresi
• GET/api/stripe/portalJWTStripe faturalama portalı adresi
• GET/api/stripe/documentsJWTStripe faturaları ve makbuzları
• GET/coinpayments/checkoutAPI anahtarıKripto ödeme adresi

Kayıtlı sepet#

Panelin sepeti, cihaz değişikliğinde kaybolmasın diye sunucuda saklanır. Sipariş vermek için gerekmez: /orders/checkout sepeti isteğin içinde alır.

• GET/api/cartJWTKayıtlı sepet
• PUT/api/cartJWTSepeti değiştir
• POST/api/cartJWTSepeti değiştir, PUT ile aynı
• DELETE/api/cartJWTSepeti boşalt

Dahili yüzeyler#

Bunlar Stripe, görev zamanlayıcı ve kayıt kötüye kullanım doğrulaması içindir. Paylaşılan sırlar veya imzalarla doğrulanırlar ve entegrasyon yüzeyinin parçası değildirler: envanter eksiksiz olsun diye listelenmişlerdir.

• POST/api/stripe/webhookStripe ödeme olayları, imzayla doğrulanır
• POST/api/jobs/tickZamanı gelen görevleri çalıştırır, paylaşılan sırla doğrulanır
• POST/api/pow/challengeKayıt proof-of-work doğrulaması
• POST/api/logs/updateE-posta etkinlik takibi
• POST/api/order/{email}Başka bir hesapta sipariş oluşturur — yalnızca yönetici listesi
• GET/reset-password/{token}Sunucuda üretilen eski parola sıfırlama sayfası, gönderilmiş bağlantılar için tutuluyor
• GET/Herkese açıkSağlık kontrolü

Site nesnesi#

/orders/getAllWebsites ve /orders/getWebsiteDetailsByName tarafından döndürülür, ayrıca her kampanyanın içine `website` olarak eklenir.

Burada geçmeyen alanlar panelin kendi arayüzünü besler. İsterseniz okuyun, ama entegrasyon sözleşmesinin parçası değiller ve haber verilmeden değişebilirler.

Kampanya nesnesi#

/orders/getAll ve /orders/get/ tarafından döndürülür. Eksik olana dikkat edin: durum alanı yok.

Burada geçmeyen alanlar panelin kendi arayüzünü besler. İsterseniz okuyun, ama entegrasyon sözleşmesinin parçası değiller ve haber verilmeden değişebilirler.

Çalışıyor mu? Bitti mi?#

Kampanyanın durum alanı yoktur, bu yüzden durumu dört sütundan çıkarırsınız. Koşulları sırayla değerlendirin ve ilk uyanı alın.

İlerleme ve iadeler#

amount_to_do kabul edilmiş oyları, amount_done ise gönderimleri sayar. Gönderimlerin yalnızca accept_rate yüzdesi kabul edilir, yani ikisi farklı birimdedir ve birini diğerinden doğrudan çıkarmak yanlıştır.

// accept_rate arrives as a STRING, and it is per-site, not global.
const rate = Number(order.website.accept_rate)

// amount_done counts SUBMISSIONS; amount_to_do counts ACCEPTED votes.
// Convert before comparing them.
const delivered = order.amount_done * rate / 100
const remaining = Math.max(order.amount_to_do - delivered, 0)
const percent   = 100 * delivered / order.amount_to_do

// What cancelling right now would put back on your balance:
const refund    = (remaining / 1000) * order.website.price_per_1000

Aynı hesap bir iptalin bedelini de verir: iade, sitenin liste fiyatı üzerinden harcanmayan kalandır, yani bir kampanyayı durdurmanın ne kazandıracağını karar vermeden önce görebilirsiniz.