Skip to main content
Este recurso tiene un sucesor en la API actual, la API versionada sobre la que deben construirse las nuevas integraciones. Esta página sigue teniendo soporte completo.
object | null
requerido
La clave de API usada para autenticar solicitudes en nombre de esta app. Null si no se ha generado ninguna clave de API. Requiere el permiso ‘developer:manage_api_key’.
AppTypes
requerido
La clasificación del público objetivo de esta app (p. ej., ‘b2b_app’, ‘b2c_app’, ‘company_app’, ‘component’).Opciones disponibles: b2b_app, b2c_app, company_app, component, website
string | null
requerido
La URL base de producción donde se aloja la app. null si no hay ninguna URL base configurada o si el llamante no tiene el permiso developer:basic:read en la cuenta de la app.Ejemplo: https://myapp.example.com
object
requerido
La empresa propietaria que publica esta app.
object
requerido
El usuario que creó y es propietario de la empresa que publicó esta app.
string | null
requerido
La plantilla de ruta URL para una vista específica de esta app, añadida al dominio base (p. ej., ‘/experiences/[experienceId]’). Null si el tipo de vista especificado no está configurado.Ejemplo: /experiences/[experienceId]
object | null
requerido
La clave de API predeterminada de la app, usada para autenticar solicitudes en nombre de esta app. Null si la app no tiene clave predeterminada. Requiere el permiso ‘developer:manage_api_key’.
string | null
requerido
Una descripción escrita de lo que hace esta app, que se muestra en la página de la ficha de la tienda de apps. Null si no se ha establecido ninguna descripción.Ejemplo: A comprehensive analytics dashboard for tracking revenue,…
string | null
requerido
La plantilla de ruta URL para una vista específica de esta app, añadida al dominio base (p. ej., ‘/experiences/[experienceId]’). Null si el tipo de vista especificado no está configurado.Ejemplo: /experiences/[experienceId]
string
requerido
El identificador de subdominio único para la URL proxy de esta app en la plataforma Whop. Forma el patrón de URL https://{domain_id}.apps.whop.com.Ejemplo: ab1c2d3e4f5g6h7i8j9k
string | null
requerido
La plantilla de ruta URL para una vista específica de esta app, añadida al dominio base (p. ej., ‘/experiences/[experienceId]’). Null si el tipo de vista especificado no está configurado.Ejemplo: /experiences/[experienceId]
string | null
requerido
La URL canónica completa donde se sirve la compilación web alojada de esta app. Null si la app no ha reclamado una ruta.Ejemplo: https://myapp.whop.site
object | null
requerido
La imagen del icono de esta app, que se muestra en la tienda de apps, las páginas de producto, el checkout y como icono predeterminado de las experiencias que usan esta app.
string
requerido
El identificador único de la app.Ejemplo: app_xxxxxxxxxxxxxx
MarketplaceStatuses | null
requerido
El estado de aprobación de la ficha de producto de esta app en la tienda de apps de Whop. Null si la app no tiene ningún producto asociado.Opciones disponibles: not_available, pending_review, live_marketplace
string
requerido
El nombre visible de esta app que se muestra en la tienda de apps y en la navegación de experiencias. Máximo 30 caracteres.Ejemplo: Courses
AppOauthClientTypes
requerido
Cómo se autentica esta app al intercambiar concesiones de autorización y de actualización de OAuth.Opciones disponibles: public, confidential
string | null
requerido
La plantilla de ruta URL para una vista específica de esta app, añadida al dominio base (p. ej., ‘/experiences/[experienceId]’). Null si el tipo de vista especificado no está configurado.Ejemplo: /experiences/[experienceId]
string | null
requerido
La URL de origen completa del dominio proxy de esta app (p. ej., ‘https://myapp.apps.whop.com’). Null si no hay ningún dominio proxy configurado.
string | null
requerido
object | null
requerido
La compilación aprobada de la app que se sirve actualmente a los usuarios en la web. Null si no hay ninguna compilación de producción desplegada para la web.
array<string>
requerido
Las URL de callback de OAuth incluidas en la lista blanca a las que se redirige a los usuarios después de autorizar la app.
array<object>
requerido
La lista de permisos que solicita esta app al instalarse, incluidos los permisos obligatorios y opcionales con sus justificaciones.
string | null
requerido
La ruta de subdominio única donde se sirven las compilaciones web alojadas de esta app, como ‘myapp’ para myapp.whop.site. Null si la app no ha reclamado una ruta.Ejemplo: myapp
object | null
requerido
Los secretos de la app como un objeto de valores de cadena. Se cifran en reposo y se inyectan en el entorno de ejecución del servidor alojado de la app como bindings de entorno. Requiere el permiso ‘developer:update_app’.
string | null
requerido
La plantilla de ruta URL para una vista específica de esta app, añadida al dominio base (p. ej., ‘/experiences/[experienceId]’). Null si el tipo de vista especificado no está configurado.Ejemplo: /experiences/[experienceId]
object | null
requerido
Estadísticas de uso agregadas de esta app, incluidos los recuentos de usuarios activos diarios, semanales y mensuales.
AppStatuses
requerido
El estado de visibilidad actual de esta app en la tienda de apps de Whop. ‘live’ significa que se puede descubrir públicamente, ‘unlisted’ significa que solo es accesible mediante un enlace directo y ‘hidden’ significa que no es visible en ningún lugar.Opciones disponibles: live, unlisted, hidden
boolean
requerido
Si Whop ha verificado esta app. Las apps verificadas cuentan con el respaldo de Whop y se muestran en la sección de apps destacadas de la tienda de apps.