Skip to main content
Whop har fem typer legitimationsoplysninger. Hvilken du skal bruge, afhænger af, hvis data du tilgår, og hvor koden kører. Vælg ud fra denne tabel, og begræns derefter legitimationsoplysningen, før den kommer i nærheden af produktion.

API-nøgler

En Account API-nøgle godkender din server som én konto. En App API-nøgle godkender din app på tværs af alle konti, der har installeret den. Begge er hemmeligheder: Hold dem på serversiden.

Opret en Account API-nøgle

Brug en Account API-nøgle, når din server handler på vegne af din egen konto og dens underkonti. Åbn Account API Keys på dashboardets Developer-side, og vælg Create. Quickstarten gennemgår det i sandboxen.

Opret en App API-nøgle

Brug en App API-nøgle, når du bygger en app og skal tilgå data på de konti, der har installeret den.
  1. Åbn Apps i dashboardet.
  2. Vælg Create app, og giv din app et navn. Du kan ændre navnet senere.
  3. Din nøgle er den skjulte værdi efter WHOP_API_KEY i sektionen Environment variables. Brug vis-knappen til at vise den, og gem den derefter et sikkert sted.

Kontoafgrænsede brugertokens

Et kontoafgrænset brugertoken handler som én bestemt bruger inden for én bestemt konto. Din server udsteder det med din API-nøgle og giver det til din klient, så dine brugere kan tilgå Whop uden nogensinde at logge ind på Whop. Opret et med POST /api/v1/access_tokens, og angiv account_id, user_id og de handlinger, du vil tillade:
account_id starter med biz_, og user_id starter med user_. Din API-nøgle skal have tilladelse til at tilgå begge. Tokens udløber som standard efter én time. Sæt expires_at for at ændre det, op til maksimalt tre timer. Udsted dem efter behov i stedet for at cache dem.

Afgrænsning af et token

scoped_actions er listen over det, tokenet må gøre. Hver post er en kolonsepareret handlingsstreng.
Hvis du lader scoped_actions være tom eller udelader den, arver tokenet alle tilladelser, som den udstedende legitimationsoplysning har. Et token, der gives til en browser, får så hele din API-nøgles rækkevidde. Angiv altid en eksplicit liste.
En handling skal være en delmængde af den udstedende legitimationsoplysnings egne tilladelser. Du kan ikke give noget, som din API-nøgle ikke har. Disse handlinger optræder i Whops guides i dag: API’et offentliggør ikke en fast liste, så betragt dette som det dokumenterede sæt snarere end det komplette. Den autoritative grænse er altid den udstedende legitimationsoplysnings egne tilladelser.

Kontoadgangstokens

Et kontoadgangstoken handler som selve kontoen uden nogen tilknyttet bruger. Opret et med POST /api/v1/access_tokens, og angiv kun account_id og de scoped_actions, der skal tillades. Det udløber efter samme tidsplan som et kontoafgrænset brugertoken. Brug det, når en klient har brug for din kontos adgang i kort tid, f.eks. en indlejret komponent, og ingen bestemt bruger er involveret. Endpoints, der handler som en bruger, f.eks. notifikations- eller præference-endpoints, afviser det.

iframe-brugertokens

Når din app vises inde i Whop, indeholder hver forespørgsel fra samme oprindelse et kortlivet JWT i x-whop-user-token-headeren. Du verificerer dets signatur for at finde ud af, hvem der spørger, og kontrollerer derefter, hvad vedkommende må se. Python- og Ruby-SDK’erne har en hjælpefunktion til dette. Det har TypeScript-SDK’et ikke, så verificer selv JWT’et. Du udsteder aldrig dette token. Whop sender det, og du validerer det. Se Godkendelse.

OAuth-tokens

Et OAuth-token repræsenterer en bruger, der har logget ind på Whop og godkendt din app til et sæt scopes. I modsætning til en API-nøgle er dets rækkevidde begrænset af, hvad den enkelte bruger kan gøre. Brug det til Sign in with Whop og til at handle på en brugers vegne i forhold til vedkommendes egen konto. Se OAuth.

Tjekliste for afgrænsning

Før en legitimationsoplysning når produktion:
  • Angiv eksplicitte scoped_actions på hvert udstedt token. Stol aldrig på nedarvning.
  • Giv API-nøgler et tilpasset sæt tilladelser, når du ved, hvilke endpoints du kalder, i stedet for at lade dem stå på Admin.
  • Hold API-nøgler på serversiden. Kun brugertokens hører hjemme i en klient.
  • Udsted kortlivede tokens efter behov i stedet for at cache langlivede.
  • Brug separate legitimationsoplysninger pr. miljø, og tjek, hvilken du har fat i, før du kører noget, der flytter penge.

Næste trin

Quickstart

Opret en sandbox-nøgle, og foretag dit første kald.

Kernebegreber

Hvordan konti, brugere og tilladelser hænger sammen.

OAuth

Hele OAuth 2.1- og PKCE-forløbet.

Test i sandboxen

Prøv legitimationsoplysninger mod testdata først.