Deze resource heeft een opvolger in de Current API, de API met versies waarop nieuwe integraties moeten bouwen. Deze pagina blijft volledig ondersteund.
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’.
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, websiteDe 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.comDe gebruiker die het bedrijf heeft aangemaakt en bezit dat deze app heeft gepubliceerd.
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]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’.
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,…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]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:
ab1c2d3e4f5g6h7i8j9kHet 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]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.siteDe pictogramafbeelding van deze app, weergegeven in de app store, op productpagina’s, bij checkout en als standaardpictogram voor experiences die deze app gebruiken.
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_marketplaceDe weergavenaam van deze app in de app store en in de navigatie van experiences. Maximaal 30 tekens.Voorbeeld:
CoursesHoe deze app zich authenticeert bij het uitwisselen van OAuth-autorisatie- en refresh-grants.Beschikbare opties:
public, confidentialHet 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]De volledige origin-URL voor het geproxyde domein van deze app (bijv. ‘https://myapp.apps.whop.com’). Null als er geen proxydomein is geconfigureerd.
De goedgekeurde app-build die momenteel op het web aan gebruikers wordt geleverd. Null als er geen productiebuild voor het web is geïmplementeerd.
De op de whitelist geplaatste OAuth-callback-URL’s waarnaar gebruikers worden doorgestuurd nadat ze de app hebben geautoriseerd.
De lijst met machtigingen die deze app aanvraagt bij installatie, inclusief zowel vereiste als optionele machtigingen met onderbouwing.
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:
myappDe 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’.
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]Geaggregeerde gebruiksstatistieken voor deze app, inclusief dagelijkse, wekelijkse en maandelijkse aantallen actieve gebruikers.
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
