Skip to main content
En app-installation er én installation af din app på én Whop-konto. Din app modtager app_installation.created, når en konto installerer den, og app_installation.deleted, når en konto fjerner den. Hver installation gemmer også to værdier, som kun din app kan ændre. external_id knytter installationen til en post i dit system, og metadata indeholder små værdier som f.eks. en synkroniseringsmarkør.

En webshop, der modtager betalinger via Whop

Denne guide følger en opdigtet app. Market Lane er et værktøj til at bygge onlinebutikker, og dets Whop-app lader en virksomhed modtage betalinger i sin Market Lane-butik via Whop. Hver butik har et handle, f.eks. river-coffee, og hver checkout på Market Lane starter med det handle. Market Lane skal vide tre ting:
  1. Hvornår en virksomhed installerer appen, så den kan forbinde virksomhedens butik.
  2. Hvilken Whop-konto der modtager betalingen, når en checkout starter i en butik.
  3. Hvornår en virksomhed fjerner appen, så dens butik holder op med at tilbyde Whop ved checkout.
1

Anmod om de tilladelser, din app har brug for

I din apps tilladelser skal du anmode om checkout_configuration:create for at oprette checkouts på kontoen og webhook_receive:payments for at få besked, når de er betalt. Virksomheden godkender begge, når den installerer appen.
2

Abonner med din apps webhook

Opret én webhook, der tilhører din app, ikke din konto: Sæt resource_id til din apps ID. Den modtager installationshændelserne for hver konto, der installerer din app, plus de betalingshændelser, som disse konti har givet adgang til.
Nøglen skal have developer:manage_webhook på den konto, der ejer appen. Gem webhook_secret fra svaret, og verificer hver levering som beskrevet i Webhooks.Kun din apps egne webhooks modtager installationshændelser. En kontos webhooks gør det aldrig, heller ikke for de apps, der er installeret på kontoen.
3

Forbind butikken, når en virksomhed installerer appen

app_installation.created indeholder installationen i data. Konvoluttens account_id er den virksomhed, der installerede appen:
Market Lane spørger virksomheden, hvilken butik der skal forbindes. Når den vælger river-coffee, gemmer Market Lane handlet på installationen som external_id:
4

Find kontoen, når en checkout starter

En kunde gennemfører checkout på river-coffee. Forespørgslen indeholder kun butikkens handle, så Market Lane slår installationen op via external_id:
Resultatet indeholder højst én installation, og dens account.id er den konto, der modtager betalingen. Market Lane opretter en checkout på den konto med POST /checkout_configurations, lægger sit eget ordre-ID i metadata og sender kunden til purchase_url. Market Lane har ingen tabel over butikshandles og Whop-konti, fordi installationen er koblingen.
5

Marker ordren som betalt

payment.succeeded ankommer på samme webhook. Dens account_id er butikkens virksomhed, og betalingen indeholder metadata fra checkouten, så Market Lane finder ordren via dens ID og markerer den som betalt.
6

Slå Whop-betalinger fra, når virksomheden fjerner appen

app_installation.deleted ankommer, så snart en virksomhed fjerner din app. Market Lane holder straks op med at tilbyde Whop ved checkout på river-coffee, så ingen kunde når frem til en checkout, der ville mislykkes. Installationen vises ikke længere i GET /app_installations, og din app kan ikke længere handle på den konto.
7

Genforbind ved geninstallation

Hvis virksomheden installerer appen igen, får du endnu en app_installation.created. Det er den samme installation: id, created_at, external_id og metadata kommer alle tilbage. Market Lane ser external_id: "river-coffee" i payloaden og slår Whop-betalinger til igen for den butik uden at bede virksomheden om at forbinde den igen.

Gem dit eget ID på en installation

  • external_id er unikt på tværs af din apps installationer. Hvis du sætter en værdi, som en anden installation allerede har, returneres en 409, så to virksomheder aldrig kan gøre krav på den samme butik. Der skelnes mellem store og små bogstaver: River-Coffee og river-coffee er forskellige.
  • metadata flettes. De nøgler, du sender, sættes, en nøgle sat til null fjernes, nøgler, du udelader, ændres ikke, og {} rydder alle nøgler. Værdier er strenge.
  • En fjernet installation beholder sit external_id. Så længe en virksomhed har fjernet din app, kan ingen anden installation af din app tage den værdi. Hvis virksomheden installerer appen igen, kommer værdien med tilbage.
  • Gem ikke hemmeligheder. Din udviklerkonto kan læse metadata og external_id.

Håndter gentagne hændelser

  • Forvent gentagelser. En virksomhed kan installere, fjerne og installere din app igen. Behandl app_installation.created for en installation, du allerede kender, som en geninstallation.
  • Ignorer dubletter via webhook-id. Whop forsøger leveringer igen, der ikke får et 2xx-svar, og et genforsøg beholder samme webhook-id.

Hvem kan læse installationer

Næste trin

Webhooks

Verificer signaturer, håndter genforsøg, og se alle hændelser.

API-reference for App Installations

Alle felter og endpoints for app-installationer.

Modtag betalinger

Opret checkouts, og lever ordrer ud fra payment.succeeded.

Tilladelser

Angiv de tilladelser, din app anmoder om ved installation.