Skip to main content
Deze resource heeft een opvolger in de Current API, de API met versies waarop nieuwe integraties moeten bouwen. Deze pagina blijft volledig ondersteund.
object | null
vereist
De API-sleutel die wordt gebruikt om verzoeken namens deze app te authenticeren. Null als er geen API-sleutel is gegenereerd. Vereist de machtiging ‘developer:manage_api_key’.
AppTypes
vereist
De classificatie van de doelgroep voor deze app (bijv. ‘b2b_app’, ‘b2c_app’, ‘company_app’, ‘component’).Beschikbare opties: b2b_app, b2c_app, company_app, component, website
string | null
vereist
De productie-basis-URL waar de app wordt gehost. null als er geen basis-URL is geconfigureerd, of als de aanroeper niet de machtiging developer:basic:read heeft op het account van de app.Voorbeeld: https://myapp.example.com
object
vereist
Het bedrijf dat eigenaar is van deze app en deze publiceert.
object
vereist
De gebruiker die het bedrijf heeft aangemaakt en bezit dat deze app heeft gepubliceerd.
string | null
vereist
Het URL-padsjabloon voor een specifieke weergave van deze app, toegevoegd aan het basisdomein (bijv. ‘/experiences/[experienceId]’). Null als het opgegeven weergavetype niet is geconfigureerd.Voorbeeld: /experiences/[experienceId]
object | null
vereist
De standaard-API-sleutel van de app, gebruikt om verzoeken namens deze app te authenticeren. Null als de app geen standaardsleutel heeft. Vereist de machtiging ‘developer:manage_api_key’.
string | null
vereist
Een geschreven beschrijving van wat deze app doet, weergegeven op de vermeldingspagina in de app store. Null als er geen beschrijving is ingesteld.Voorbeeld: A comprehensive analytics dashboard for tracking revenue,…
string | null
vereist
Het URL-padsjabloon voor een specifieke weergave van deze app, toegevoegd aan het basisdomein (bijv. ‘/experiences/[experienceId]’). Null als het opgegeven weergavetype niet is geconfigureerd.Voorbeeld: /experiences/[experienceId]
string
vereist
De unieke subdomeinidentificatie voor de geproxyde URL van deze app op het Whop-platform. Vormt het URL-patroon https://{domain_id}.apps.whop.com.Voorbeeld: ab1c2d3e4f5g6h7i8j9k
string | null
vereist
Het URL-padsjabloon voor een specifieke weergave van deze app, toegevoegd aan het basisdomein (bijv. ‘/experiences/[experienceId]’). Null als het opgegeven weergavetype niet is geconfigureerd.Voorbeeld: /experiences/[experienceId]
string | null
vereist
De volledige canonieke URL waar de gehoste webbuild van deze app wordt geleverd. Null als de app geen route heeft geclaimd.Voorbeeld: https://myapp.whop.site
object | null
vereist
De pictogramafbeelding van deze app, weergegeven in de app store, op productpagina’s, bij checkout en als standaardpictogram voor experiences die deze app gebruiken.
string
vereist
De unieke identificatie van de app.Voorbeeld: app_xxxxxxxxxxxxxx
MarketplaceStatuses | null
vereist
De goedkeuringsstatus van de productvermelding van deze app in de Whop app store. Null als de app geen gekoppeld product heeft.Beschikbare opties: not_available, pending_review, live_marketplace
string
vereist
De weergavenaam van deze app in de app store en in de navigatie van experiences. Maximaal 30 tekens.Voorbeeld: Courses
AppOauthClientTypes
vereist
Hoe deze app zich authenticeert bij het uitwisselen van OAuth-autorisatie- en refresh-grants.Beschikbare opties: public, confidential
string | null
vereist
Het URL-padsjabloon voor een specifieke weergave van deze app, toegevoegd aan het basisdomein (bijv. ‘/experiences/[experienceId]’). Null als het opgegeven weergavetype niet is geconfigureerd.Voorbeeld: /experiences/[experienceId]
string | null
vereist
De volledige origin-URL voor het geproxyde domein van deze app (bijv. ‘https://myapp.apps.whop.com’). Null als er geen proxydomein is geconfigureerd.
string | null
vereist
object | null
vereist
De goedgekeurde app-build die momenteel op het web aan gebruikers wordt geleverd. Null als er geen productiebuild voor het web is geïmplementeerd.
array<string>
vereist
De op de whitelist geplaatste OAuth-callback-URL’s waarnaar gebruikers worden doorgestuurd nadat ze de app hebben geautoriseerd.
array<object>
vereist
De lijst met machtigingen die deze app aanvraagt bij installatie, inclusief zowel vereiste als optionele machtigingen met onderbouwing.
string | null
vereist
De unieke subdomeinroute waar de gehoste webbuilds van deze app worden geleverd, zoals ‘myapp’ voor myapp.whop.site. Null als de app geen route heeft geclaimd.Voorbeeld: myapp
object | null
vereist
De secrets van de app als object met stringwaarden. Versleuteld opgeslagen en als omgevingsbindingen geïnjecteerd in de gehoste serverruntime van de app. Vereist de machtiging ‘developer:update_app’.
string | null
vereist
Het URL-padsjabloon voor een specifieke weergave van deze app, toegevoegd aan het basisdomein (bijv. ‘/experiences/[experienceId]’). Null als het opgegeven weergavetype niet is geconfigureerd.Voorbeeld: /experiences/[experienceId]
object | null
vereist
Geaggregeerde gebruiksstatistieken voor deze app, inclusief dagelijkse, wekelijkse en maandelijkse aantallen actieve gebruikers.
AppStatuses
vereist
De huidige zichtbaarheidsstatus van deze app in de Whop app store. ‘live’ betekent openbaar vindbaar, ‘unlisted’ betekent alleen toegankelijk via een directe link, en ‘hidden’ betekent nergens zichtbaar.Beschikbare opties: live, unlisted, hidden
boolean
vereist
Of deze app door Whop is geverifieerd. Geverifieerde apps worden door Whop aanbevolen en weergegeven in de sectie met uitgelichte apps van de app store.