Skip to main content
Kendi ürününüzden ücretli görevler yayınlayın, bunları bir hesabın bakiyesinden fonlayın ve gönderim kuyruğunu kendi arayüzünüze çekin. Bu kılavuz tüm döngüyü kapsar: bir ödül görevi oluşturma, iş alma, inceleme ve iptal etme.
Bir ödül görevi yayınlamak para hareketi gerektirdiğinden bounty:create ve payout:transfer_funds izinlerine sahip bir API anahtarına ihtiyacınız vardır. Gönderimleri okumak için bounty:basic:read gerekir.

Bir ödül görevi yayınlayın

POST /bounties bir title, bir çalışanın izleyeceği talimatları içeren bir description ve bir gross_reward_amount gerektirir.

Ödülün size maliyeti

gross_reward_amount, ödül görevi başına değil, kabul edilen gönderim başına tam ABD doları cinsindendir. accepted_submissions_limit kaç gönderimin kazanabileceğini belirler ve varsayılan değeri 1’dir. Whop bu ikisinin çarpımını emanete alır ve bu toplam en az 5 olmalıdır.Yukarıdakio¨rnek100olmalıdır. Yukarıdaki örnek 100 emanete alır. Platform ücretleri ve satış ortağı payları üzerine eklenmek yerine brüt tutardan düşülür, bu nedenle 25 ′lıkbiro¨du¨lfonlayana25'lık bir ödül fonlayana 25 ‘a mal olur.

Paranın kaynağı

Havuz varsayılan olarak çağıranın kişisel bakiyesinden çekilir. Bunun yerine bir hesabın bakiyesinden fonlamak için account_id geçirin; bu, o hesabın fonlarını hareket ettirme izni gerektirir.

Ödül görevinin bulunduğu yer

experience_id, bir ödül görevini belirli bir deneyime yerleştirir: açık bir ödül görevi için herkese açık, davetli bir ödül görevi için özel; ve account_id ayarlamadığınız sürece zorunludur. account_id ayarlayıp deneyimi atladığınızda, ödül görevi o hesabın herkese açık forumuna bağlanır.

Hedefi belirtme

business_goal_type, işin neyi başarmayı amaçladığını belirtir ve bunu ödül görevini oluştururken bir kez belirtirsiniz. clipping, post_engagement, owned_account_growth, ugc_content, local_activation, data_capture veya other değerlerini alır. capture_spec yalnızca hedef data_capture olduğunda kabul edilir. Başka bir hedefle gönderilmesi başarısız olur.

Planlayın ve tekrarlayın

Bir ödül görevi, publish_at ayarlamadığınız sürece oluşturduğunuz anda yayınlanır. Whop onu gizli bir taslak olarak oluşturur, ardından belirttiğiniz zamanda fonlar ve yayınlar. publish_at ayarlandığında publish_at_timezone zorunludur. frequency, planlanmış bir ödül görevini yinelenen bir göreve dönüştürür. Varsayılan değeri once’dır, hourly, daily, weekly veya monthly değerlerini alır ve yalnızca publish_at ile birlikte uygulanır. Her tekrar, kendi gönderimleri ve kendi emaneti olan ayrı bir ödül görevidir.

Bir ödül görevini düzenleyin

PATCH /bounties/{id} uç noktasının neyi kabul ettiği, ödül görevinin yayınlanıp yayınlanmadığına bağlıdır. Planlanmış bir taslak her şeyi kabul eder: ödülü, kazanan yuvalarını, planı ve içerik alanlarını. Yayınlanmış bir ödül görevi yalnızca içeriği, yani title, description, allowed_country_codes ve business_goal_type değerlerini kabul eder. Ödül görevi girişim kabul etmeyi bıraktığında veya herhangi bir gönderim submitted ya da approved durumuna ulaştığında bunlar bile reddedilir. Bir ödül görevi yayınlandığında ödül, kazanan yuvaları ve plan sabitlenir. accepted_submissions_per_user_limit, bir çalışanın kaç yuva kazanabileceğini sınırlar. Varsayılan değeri 1’dir, accepted_submissions_limit değerini aşamaz ve bir çalışan aynı anda bir girişim yürütür.

Gönderimleri alın

POST /bounty_submissions, bounty_id ve bir deliverable alır. urls, file_ids ve bir caption değerini en az bir bağlantı veya bir dosya olacak şekilde birleştirin. Whop boş bir teslimatı reddeder. Standart bir ödül görevinde bu tek çağrı çalışanın tüm akışıdır ve gönderim doğrudan incelemeye gider. Gönderimler bir kullanıcı kimlik bilgisi gerektirir, bu nedenle bir Account API anahtarı gönderim oluşturamaz.
allowed_country_codes, bir ödül görevinde kimlerin çalışabileceğini kısıtlar. ISO 3166 alpha-2 kodlarını alır. Boş bir liste dünya genelinde anlamına gelir. Bir çalışan kendi girişimini DELETE /bounty_submissions/{id} ile geri çekebilir. Bunu yalnızca girişimi başlatan çalışan yapabilir ve bir Account API anahtarı bunu onun adına yapamaz.

Entegrasyonunuzun tamamlayamayacağı hedefler

İki hedef türü kanıtlarını API dışında biriktirir. Bir data_capture ödül görevinde gönderimi bir teslimat olmadan oluşturun: bu, kliplerinin sunucu tarafında biriktiği talep edilmiş bir girişim başlatır. Bir canlı yayın ödül görevinin kanıtı, herkese açık API’nin sunmadığı bir yüzey üzerinden ilerler. Entegrasyonunuz bu ödül görevlerini yayınlayabilir ve kuyruklarını okuyabilir, ancak çalışan girişimi Whop’ta tamamlar.

Kuyruğu inceleyin

Gönderimleri bounty_id ve isteğe bağlı olarak status ile filtrelenmiş şekilde GET /bounty_submissions ile okuyun.
Bir gönderim dört durumdan geçer:
Onaylama ve reddetme Whop kontrol panelinde gerçekleşir. API’de onaylama veya reddetme işlemi yoktur; bu nedenle ürününüz kuyruğu ve sonuçlarını gösterebilir, ancak kararı Whop’ta bir kişi verir.
Ödül görevleri webhook yaymaz. Sonuçları kendi ürününüze yansıtmak için ödül görevine göre filtrelenmiş GET /bounty_submissions uç noktasını yoklayın. Bir kişinin incelediği bir kuyruk için dakikada bir uygundur. Bir ödül görevinde yakın zamanda etkinlik yoksa birkaç dakikada bire düşürün.

Bir ödül görevini iptal edin

POST /bounties/{id}/cancel, işlemde olan bir iş yoksa fonlayana hemen iade yapar. İncelemede bir iş varsa yeni gönderimleri durdurur ve o iş sonuçlanıp ödendikten sonra iptal eder. İsteği tekrarlamak hiçbir şey yapmaz. Tüm yuvaları zaten ödenmiş bir ödül görevi 400 döndürür.

Doğrulamayı geçip yine de başarısız olan istekler

İstek şemasının ifade edemediği dört kural. Gövde doğru biçimlendirilmiş olsa bile her biri bir hata döndürür:
  • account_id ayarlanmamışken experience_id atlanması.
  • frequency değerinin publish_at olmadan gönderilmesi.
  • business_goal_type değeri data_capture dışında bir şeyken capture_spec gönderilmesi.
  • Ne bağlantı ne de dosya içeren bir deliverable.

Sonraki adımlar

Ödül görevlerine genel bakış

Nesneler ve birbirleriyle nasıl uyum sağladıkları.

Dosya yükleyin

Bir teslimatın başvurduğu dosya kimliklerini alın.

Ödül görevleri referansı

Her uç nokta için istek ve yanıt yapıları.

Ödül görevi gönderimleri referansı

Gönderim nesnesi ve filtreleri.