Dokümantasyon

Tarayıcıda tek bir script, sunucunuzdan tek bir API çağrısı. Yayına geçmek için gereken her şey tek sayfada.

Hızlı başlangıç

Tarayıcı için public key'inize (pk_...) ve sunucunuz için secret key'inize (sk_...) ihtiyacınız var. İkisi de panelde, Siteler ve anahtarlar bölümünde.

1. Script'i ekleyin

Bu etiketi kullanıcıların kayıt olduğu, giriş yaptığı, offer'lara tıkladığı veya cashout talep ettiği sayfalara ekleyin. Kendini şu öznitelikten başlatır: data-key

<script src="https://cashoutguard.com/v1/agent.js" data-key="pk_live_YOUR_PUBLIC_KEY" async></script>

2. request_id'yi toplayıp sunucunuza gönderin

Önemli anda collect() fonksiyonunu olay adıyla çağırın. Dönen değer: { request_id, visitor_id }

const { request_id } = await CashoutGuard.collect({ event: 'cashout' });

collect() asla reject etmez. Başarısız olursa (engellendi, çevrimdışı, zaman aşımı) request_id: null ve bir hata metniyle resolve olur. Formu yine de gönderin, kararı sunucunuz versin.

3. Sunucunuzdan karar isteyin

Olayı, secret key'iniz header'da olacak şekilde /v1/evaluate adresine POST edin: Authorization: Bearer sk_live_...

Secret key'i asla tarayıcı koduna veya mobil uygulamaya koymayın. /v1/evaluate yalnızca sunucunuz tarafından çağrılmalı.

Evaluate isteği

POST https://cashoutguard.com/v1/evaluate bir hesap için tek bir olayı puanlar, onu cihazı, ağı ve ödeme adresiyle ilişkilendirir ve bir karar döndürür. JSON gönderin.

Yanıt

Yanıt her zaman aynı yapıdadır. Geçerli olmayan alanlar null olur.

• score 0 ile 100 arasındadır. Nedenler birleştirilir; böylece birkaç orta düzey sinyal 100'ü aşmadan toplanır.
• reasons tetiklenen her sinyali, en güçlüden başlayarak ağırlığı, ayrıntıları ve olduğu gibi gösterebileceğiniz sade İngilizce bir etiketle listeler.
• device.confidence cihazın ne kadar benzersiz göründüğünü söyler. Fingerprint'ler taklit edilebilir, bu yüzden asla kesinlik iddia etmeyiz.
• linked_accounts bu hesapla aynı cihazı, ödeme adresini veya e-postayı paylaşan diğer hesapları listeler.
• cashout yalnızca cashout olaylarında doldurulur ve inceleme kuyruğunuzdaki durumu gösterir.

Kararlar ve action

decision alanına göre değil, action alanına göre hareket edin. Aşağıdaki eşikler varsayılandır ve panelden site bazında değiştirilebilir.

Shadow modunda action her zaman allow olur, bu yüzden aynı kodu enforce'a geçmeden önce güvenle yayına alabilirsiniz. Enforce'a geçtiğinizde kodunuzda hiçbir şey değişmez.

Olay türleri

Elinizdeki olayları gönderin. En önemlileri signup ve cashout; conversion olayları offer hızı kontrollerini besler.

Offerwall'lar ve postback'ler

Offerwall dönüşümleri postback ile, sunucudan sunucuya, tarayıcı olmadan gelir. CashoutGuard her dönüşümü onu başlatan tıklamaya bağlar; böylece dönüşüm o tıklamanın cihazı ve ağıyla puanlanır.

1. Kullanıcı bir teklifi açtığında

Tarayıcıda toplayın ve teklif ile tıklama kimliğinizle bir offer_click gönderin.

2. Postback geldiğinde

Postback işleyicinizden aynı account_id ve click_id ile bir conversion gönderin. request_id gerekmez. Offerwall veriyorsa kullanıcının IP'sini de iletin.

Dönüşümler şunlar için kontrol edilir: teklif için fazla hızlı tamamlanma, tıklamasız dönüşüm, farklı ülkelerden tıklama ve dönüşüm, hesabın olağan gününün çok üstünde kazanç ve yinelenen işlem kimlikleri.

Offerwall ağları

Çok sayıda yayıncısı olan bir ağ işletiyorsanız, yayıncıyı içeren hesap kimlikleri gönderin ve Siteler bölümünde "Offerwall ağı modu"nu açın. Böylece hesaplar yalnızca aynı yayıncı içinde bağlanır, çünkü bir kişinin yayıncılarınızın birkaç sitesini kullanması normaldir. Biçim: publisher_id:user_id

Teklif kataloğu

POST /v1/offers teklif adlarınızı gönderir (çağrı başına en fazla 1.000). Geçmiş ve gelecek olaylar yalnızca kimlik taşısa bile gerçek adı gösterir.

Neden kodları

Bu kodlar reasons[].code içinde görünür. Metni moderatörlerinize gösterin; mantığınızda kodu kullanın.

Ağırlıklar noisy-OR ile birleştirilir: score = 100 x (1 - (1 - weight/100) çarpımı). 40'lık iki sinyal 80 değil, 64 verir. Engel listesi eşleşmesi her zaman 100 verir.

Webhook'lar

Panelde bir webhook URL’si ayarlayın. block olarak puanlanan her olay (event.blocked), bir hesap block’a geçtiğinde (account.blocked) ve ekibiniz bir çekim kararı verdiğinde (cashout.decided) POST gönderiyoruz. Kullanmadığınız türleri yok sayın.

Her istek webhook secret'ınızla imzalanır. Ham gövdenin hex formatındaki HMAC-SHA256 değeri şu header'dadır: X-CashoutGuard-Signature

Herhangi bir 2xx durum koduyla yanıt verin. Başarısız gönderimler en fazla 5 kez yeniden denenir: 10 saniye, 1 dakika, 5 dakika ve 15 dakika sonra.

Hesap durumu

GET /v1/accounts/{account_id} olay oluşturmadan bir hesabın güncel risk görünümünü döndürür.

POST /v1/accounts/{account_id}/status kendi moderasyon araçlarınızın bir hesabın durumunu değiştirmesini sağlar.

• active: Normal puanlama.
• allowlisted: Skorlar inceleme eşiğinin altında sınırlanır. Güvenilir kullanıcılar ve ekip üyeleri için.
• blocked: Her olay 100 skorla block döndürür.

İptaller ve doğruluk

POST /v1/outcomes puanladıktan sonra dönüşümlere ne olduğunu bildirir: offerwall veya reklamveren tarafından iptal edildi (chargeback) ya da geçerli onaylandı. Kimliklerinizi eşleştirip motoru Doğruluk sayfasında kendi trafiğinizde ölçeriz.

Kodsuz: offerwall'larınızın aylık iptal dosyasını (CSV veya Excel) Doğruluk sayfasına yükleyin. Kimlik sütununu otomatik buluruz.

PHP, Node.js, Python, Android

SDK gerekmez. Kısa zaman aşımlı sade bir HTTP çağrısı yeterli. Tam cashout örneği:

• cashoutguard.php: PHP 7.4+, tek dosya, Composer yok. require edip kullanın.
• composer require cashoutguard/cashoutguard-php: aynı PHP istemcisi README ile, vendor klasörünüz için.
• npm install @cashoutguard/node: Node 18+, TypeScript tipleriyle.
• cashoutguard-wordpress.zip: WordPress eklentisi: her sayfada tarayıcı betiği, puanlanan kayıt ve girişler, ayrıca para çekme, offerwall dönüşümleri ve iptaller için hook'lar.

Hatalar ve limitler

Fail open: çağrı zaman aşımına uğrarsa veya hata verirse işleme izin verin ve kaydını tutun. Bizim tarafımızdaki bir kesinti kullanıcılarınızı asla durdurmasın.