Skip to main content
Slå betalte opgaver op fra dit eget produkt, finansiér dem fra en kontos saldo, og træk indsendelseskøen ind i din egen brugerflade. Denne guide dækker hele forløbet: oprettelse af en bounty, modtagelse af arbejde, gennemgang af det og annullering.
Du skal bruge en API-nøgle med bounty:create og payout:transfer_funds, fordi oprettelse af en bounty flytter penge. Læsning af indsendelser kræver bounty:basic:read.

Slå en bounty op

POST /bounties kræver en title, en description med de instruktioner, en udfører følger, og et gross_reward_amount.

Hvad belønningen koster dig

gross_reward_amount er hele amerikanske dollars pr. accepteret indsendelse, ikke pr. bounty. accepted_submissions_limit angiver, hvor mange indsendelser der kan vinde, og er som standard 1. Whop deponerer de to ganget sammen, og den total skal være mindst $5. Eksemplet ovenfor deponerer $100. Platformgebyrer og affiliate-andele trækkes fra bruttobeløbet i stedet for at blive lagt oveni, så en belønning på $25 koster finansieringskilden $25.

Hvor pengene kommer fra

Puljen trækker som standard på kalderens personlige saldo. Angiv account_id for i stedet at finansiere den fra en kontos saldo, hvilket kræver tilladelse til at flytte den kontos midler.

Hvor bountyen befinder sig

experience_id placerer en bounty i en bestemt experience, offentlig for en åben bounty eller privat for en inviteret, og den er påkrævet, medmindre du angiver account_id. Når du angiver account_id og udelader experiencen, forankres bountyen i den kontos offentlige forum.

Angivelse af målet

business_goal_type angiver, hvad arbejdet skal opnå, og du angiver det én gang, når du opretter bountyen. Det tager clipping, post_engagement, owned_account_growth, ugc_content, local_activation, data_capture eller other. capture_spec accepteres kun, når målet er data_capture. Hvis det sendes med et andet mål, mislykkes anmodningen.

Planlæg og gentag

En bounty udgives, så snart du opretter den, medmindre du angiver publish_at. Whop opretter den som en skjult kladde og finansierer og udgiver den derefter på det tidspunkt, du har angivet. publish_at_timezone er påkrævet, når publish_at er angivet. frequency gør en planlagt bounty til en tilbagevendende. Den er som standard once, tager hourly, daily, weekly eller monthly og gælder kun sammen med publish_at. Hver forekomst er en separat bounty med sine egne indsendelser og sit eget depot.

Redigér en bounty

Hvad PATCH /bounties/{id} accepterer, afhænger af, om bountyen er udgivet. En planlagt kladde accepterer alt: belønningen, vinderpladserne, tidsplanen og indholdsfelterne. En udgivet bounty accepterer kun indhold, dvs. title, description, allowed_country_codes og business_goal_type. Selv de afvises, når bountyen holder op med at acceptere forsøg, eller når en indsendelse når submitted eller approved. Belønningen, vinderpladserne og tidsplanen ligger alle fast, når en bounty er udgivet. accepted_submissions_per_user_limit begrænser, hvor mange pladser én udfører kan vinde. Den er som standard 1, kan ikke overstige accepted_submissions_limit, og en udfører kører ét forsøg ad gangen.

Modtag indsendelser

POST /bounty_submissions tager bounty_id og en deliverable. Kombinér urls, file_ids og en caption, med mindst ét link eller én fil. Whop afviser en tom leverance. På en almindelig bounty er dette ene kald hele udførerens forløb, og indsendelsen går direkte til gennemgang. Indsendelser kræver en brugerlegitimation, så en konto-API-nøgle kan ikke oprette en.
allowed_country_codes begrænser, hvem der kan udføre en bounty. Det tager ISO 3166 alpha-2-koder. En tom liste betyder hele verden. En udfører kan trække sit eget forsøg tilbage med DELETE /bounty_submissions/{id}. Kun den udfører, der startede det, kan gøre det, og en konto-API-nøgle kan ikke gøre det for vedkommende.

Mål, din integration ikke kan fuldføre

To måltyper samler deres dokumentation uden for API’et. På en data_capture-bounty skal du oprette indsendelsen uden en leverance: det starter et påtaget forsøg, hvis klip samles på serversiden. Dokumentation for en livestream-bounty kører gennem en flade, som det offentlige API ikke eksponerer. Din integration kan slå disse bounties op og læse deres køer, men en udfører afslutter forsøget i Whop.

Gennemgå køen

Læs indsendelser med GET /bounty_submissions, filtreret efter bounty_id og eventuelt efter status.
En indsendelse bevæger sig gennem fire tilstande:
Godkendelse og afvisning sker i Whop-dashboardet. API’et har ingen operation til godkendelse eller afvisning, så dit produkt kan vise køen og dens resultater, men en person træffer beslutningen i Whop.
Bounties udsender ingen webhooks. For at afspejle resultater i dit eget produkt skal du polle GET /bounty_submissions filtreret til bountyen. Én gang i minuttet passer til en kø, som en person gennemgår. Skru ned til hvert par minutter, når en bounty ikke har haft nogen nylig aktivitet.

Annullér en bounty

POST /bounties/{id}/cancel refunderer straks finansieringskilden, når intet arbejde er undervejs. Når arbejde er under gennemgang, stopper det nye indsendelser og annullerer, når det arbejde er afgjort og udbetalt. Gentagelse af anmodningen gør intet. En bounty, der allerede har udbetalt alle pladser, returnerer en 400.

Anmodninger, der består validering og alligevel mislykkes

Fire regler, som anmodningsskemaet ikke kan udtrykke. Hver returnerer en fejl, selvom body’en er velformet:
  • experience_id udeladt uden at account_id er angivet.
  • frequency sendt uden publish_at.
  • capture_spec sendt, når business_goal_type er noget andet end data_capture.
  • En deliverable, der hverken indeholder et link eller en fil.

Næste trin

Oversigt over bounties

Objekterne, og hvordan de hænger sammen.

Upload filer

Få de fil-ID’er, en leverance refererer til.

Bounties-reference

Anmodnings- og svarformer for alle endpoints.

Reference for bounty-indsendelser

Indsendelsesobjektet og dets filtre.