Skip to main content
Publiez des tâches rémunérées depuis votre propre produit, financez-les depuis le solde d’un compte et intégrez la file des soumissions à votre propre interface. Ce guide couvre le cycle complet : créer une bounty, recueillir le travail, l’examiner et annuler.
Vous avez besoin d’une clé API disposant de bounty:create et payout:transfer_funds, car publier une bounty déplace de l’argent. La lecture des soumissions nécessite bounty:basic:read.

Publier une bounty

POST /bounties nécessite un title, une description contenant les instructions que suit le participant, et un gross_reward_amount.

Ce que vous coûte la récompense

gross_reward_amount est un montant en dollars américains entiers par soumission acceptée, et non par bounty. accepted_submissions_limit définit combien de soumissions peuvent l’emporter, et vaut 1 par défaut. Whop place sous séquestre le produit des deux, et ce total doit être d’au moins 5 .L′exempleci−dessusplace100. L'exemple ci-dessus place 100 sous séquestre. Les frais de plateforme et les parts d’affiliation sont prélevés sur le montant brut au lieu de s’y ajouter : une récompense de 25 cou^tedonc25coûte donc 25 au financeur.

D’où vient l’argent

La cagnotte puise par défaut dans le solde personnel de l’appelant. Passez account_id pour la financer plutôt depuis le solde d’un compte, ce qui nécessite la permission de déplacer les fonds de ce compte.

Où se trouve la bounty

experience_id place une bounty dans une expérience précise, publique pour une bounty ouverte ou privée pour une bounty sur invitation, et il est obligatoire sauf si vous définissez account_id. Lorsque vous définissez account_id et omettez l’expérience, la bounty est rattachée au forum public de ce compte.

Déclarer l’objectif

business_goal_type indique ce que le travail est censé accomplir, et vous le déclarez une seule fois lors de la création de la bounty. Il accepte clipping, post_engagement, owned_account_growth, ugc_content, local_activation, data_capture ou other. capture_spec n’est accepté que lorsque l’objectif est data_capture. L’envoyer avec un autre objectif échoue.

Planifier et répéter

Une bounty est publiée dès sa création, sauf si vous définissez publish_at. Whop la crée alors sous forme de brouillon masqué, puis la finance et la publie à l’heure indiquée. publish_at_timezone est obligatoire dès que publish_at est défini. frequency transforme une bounty planifiée en bounty récurrente. Il vaut once par défaut, accepte hourly, daily, weekly ou monthly, et ne s’applique qu’avec publish_at. Chaque occurrence est une bounty distincte avec ses propres soumissions et son propre séquestre.

Modifier une bounty

Ce qu’accepte PATCH /bounties/{id} dépend de la publication ou non de la bounty. Un brouillon planifié accepte tout : la récompense, les places de gagnants, le calendrier et les champs de contenu. Une bounty publiée n’accepte que le contenu, c’est-à-dire title, description, allowed_country_codes et business_goal_type. Même ces champs sont refusés dès que la bounty n’accepte plus de tentatives, ou dès qu’une soumission atteint submitted ou approved. La récompense, les places de gagnants et le calendrier sont tous figés une fois la bounty publiée. accepted_submissions_per_user_limit plafonne le nombre de places qu’un participant peut remporter. Il vaut 1 par défaut, ne peut pas dépasser accepted_submissions_limit, et un participant mène une seule tentative à la fois.

Recueillir des soumissions

POST /bounty_submissions accepte le bounty_id et un deliverable. Combinez urls, file_ids et une caption, avec au moins un lien ou un fichier. Whop rejette un livrable vide. Sur une bounty standard, cet unique appel constitue tout le parcours du participant, et la soumission passe directement en examen. Les soumissions nécessitent des identifiants utilisateur, donc une clé API de compte ne peut pas en créer.
allowed_country_codes limite qui peut travailler sur une bounty. Il accepte des codes ISO 3166 alpha-2. Une liste vide signifie le monde entier. Un participant peut retirer sa propre tentative avec DELETE /bounty_submissions/{id}. Seul le participant qui l’a lancée peut le faire, et une clé API de compte ne peut pas le faire à sa place.

Objectifs que votre intégration ne peut pas finaliser

Deux types d’objectifs accumulent leurs preuves en dehors de l’API. Sur une bounty data_capture, créez la soumission sans livrable : cela démarre une tentative réservée dont les clips s’accumulent côté serveur. La preuve d’une bounty de livestream passe par une interface que l’API publique n’expose pas. Votre intégration peut publier ces bounties et lire leurs files, mais le participant termine la tentative dans Whop.

Examiner la file

Lisez les soumissions avec GET /bounty_submissions, filtrées par bounty_id et éventuellement par status.
Une soumission passe par quatre états :
L’approbation et le refus se font dans le tableau de bord Whop. L’API n’a pas d’opération d’approbation ou de refus : votre produit peut afficher la file et ses résultats, mais c’est une personne qui décide dans Whop.
Les bounties n’émettent aucun webhook. Pour refléter les résultats dans votre propre produit, interrogez régulièrement GET /bounty_submissions filtré sur la bounty. Une fois par minute convient à une file examinée par une personne. Espacez à toutes les quelques minutes lorsqu’une bounty n’a pas d’activité récente.

Annuler une bounty

POST /bounties/{id}/cancel rembourse immédiatement le financeur lorsqu’aucun travail n’est en cours. Lorsque du travail est en cours d’examen, il bloque les nouvelles soumissions et annule une fois ce travail résolu et payé. Répéter la requête n’a aucun effet. Une bounty qui a déjà versé toutes ses places renvoie une erreur 400.

Requêtes qui passent la validation mais échouent quand même

Quatre règles que le schéma de requête ne peut pas exprimer. Chacune renvoie une erreur même si le corps est bien formé :
  • experience_id omis sans account_id défini.
  • frequency envoyé sans publish_at.
  • capture_spec envoyé lorsque business_goal_type est autre chose que data_capture.
  • Un deliverable ne contenant ni lien ni fichier.

Étapes suivantes

Vue d'ensemble des bounties

Les objets et la façon dont ils s’articulent.

Téléverser des fichiers

Obtenez les ID de fichiers référencés par un livrable.

Référence Bounties

Formats de requête et de réponse pour chaque endpoint.

Référence des soumissions de bounty

L’objet soumission et ses filtres.