Skip to main content
La API de Whop consta de un pequeño número de objetos que se conectan de formas predecibles. Esta página define cada uno y lo indica claramente cuando un objeto tiene más de un nombre.

Cuentas e identidad

biz_
Un negocio en Whop. Es propietario de claves de API, productos, webhooks y dinero. Consulta Cuentas.
user_
Una persona con inicio de sesión en Whop. Un usuario puede comprar a muchas cuentas y también puede ayudar a gestionar una. Consulta Usuarios.
Un usuario al que se le concede acceso para operar una cuenta. Su rol determina lo que puede hacer. Consulta Miembros del equipo.
Un usuario visto como cliente: alguien que tiene o tuvo una membresía de algo que vende la cuenta. Consulta Miembros.

Subcuenta

Una cuenta que das de alta y en cuyo nombre actúas cuando gestionas un marketplace. Cobras pagos en su nombre y le realizas pagos salientes. Las guías de plataforma a veces la llaman submerchant. Las dos palabras se refieren al mismo objeto. El inicio rápido de plataformas recorre todo el flujo.
La comprobación de identidad que una cuenta debe superar antes de poder recibir pagos salientes. Las personas físicas completan comprobaciones Know Your Customer (KYC). Las empresas completan comprobaciones Know Your Business (KYB). Consulta Verificaciones.
idpf_
El registro de los datos de identidad verificados que produce una verificación.

Lo que vendes

Una cuenta vende productos. Un producto incluye una o más variantes, que fijan el precio, y se conecta a las experiencias que realmente recibe un comprador.
prod_
Algo que vende una cuenta. Contiene la descripción, los medios y las variantes entre las que puede elegir un comprador. Consulta Productos.
plan_
Una configuración comprable de un producto, con su propio precio, forma de facturación, stock, SKU y atributos. Los ID de variante conservan el prefijo plan_. Consulta Variantes.
mem_
Lo que obtiene un comprador cuando paga. Vincula a un usuario con una variante e incluye un estado que te indica si el acceso es válido en este momento. Consulta Membresías.

Experiencia

Una unidad de contenido o funcionalidad dentro de lo que vende una cuenta. Un producto se conecta a una o más experiencias, y una membresía de ese producto es lo que concede acceso a ellas. Este es el sustantivo más específico de la plataforma Whop y el que no puedes deducir por su nombre. Si estás creando una app que se ejecuta dentro de Whop, la experiencia es aquello en lo que se renderiza tu app. Consulta Vistas de app.

Derecho de acceso

El registro que indica que un usuario puede usar algo específico en este momento. El acceso es la pregunta, y el derecho de acceso es la respuesta almacenada. Compruébalo con respecto a una cuenta, un producto o una experiencia. Consulta Autenticación.

Cómo se mueve el dinero

El dinero llega, se queda en algún lugar y luego sale. Cada objeto a continuación es un paso en ese camino, en el orden en que ocurre.
ch_
La definición reutilizable de una compra: qué variante, a qué precio y con qué redirección. Produce una página de checkout activa. Consulta Configuraciones de checkout.
pay_
Un intento de mover dinero de un comprador a una cuenta, con un estado que indica si funcionó.
El mismo evento descrito desde el lado de la red de tarjetas. La documentación usa ambas palabras. El objeto de la API es el pago.

Libro mayor

El registro continuo de cada crédito y débito en el dinero de una cuenta. Es la fuente de verdad de lo que tiene una cuenta y de lo que se le debe. El dinero llega a un libro mayor antes de ir a cualquier otro lugar. Consulta Actividad del libro mayor.
El importe que hay en un libro mayor en este momento y que puedes gastar o retirar.
Una parte de un saldo que Whop retiene como garantía frente a futuros reembolsos y disputas. Se libera según un calendario.
La parte de un pago que se queda Whop, descontada antes de que el dinero llegue a un saldo.
Dinero añadido a un saldo desde fuera de Whop. Consulta Depósitos.
Dinero que sale de un saldo hacia una cuenta bancaria o billetera fuera de Whop. Consulta Pagos salientes.
Dinero que se mueve entre dos cuentas dentro de Whop, sin salir al mundo exterior. Consulta Transferencias.
Una conversión de un saldo entre tokens, cadenas o destinos de billetera compatibles. Consulta Swaps.
icrd_
Una tarjeta virtual emitida por Whop que gasta del saldo de una cuenta o de un usuario. Consulta Tarjetas.
Un pago completado que se devuelve al comprador, iniciado por ti.
Un pago revertido por el banco del comprador en su nombre. Puedes impugnarlo. Consulta Disputas.

Construir sobre Whop

Plataforma significa dos cosas en esta documentación. Whop como plataforma es el producto con el que te estás integrando. Una plataforma en el sentido de marketplace eres tú, una vez que das de alta subcuentas y te quedas con una parte de lo que venden. La frase que lo rodea te indica a cuál se refiere.
app_
Software que se ejecuta dentro de Whop y llega a una audiencia a través de su marketplace. Consulta Apps.
Una pantalla que una app renderiza dentro de Whop: la vista de experiencia orientada al cliente o la vista de panel orientada al creador. Consulta Vistas de app.
La forma en que Whop incrusta las páginas de tu app en su propia interfaz. Tu app se ejecuta en tus servidores y se renderiza dentro del marco de Whop. Consulta iframe.
Una capacidad individual que una clave de API puede ejercer. Consulta Permisos.

Scope

La misma idea que un permiso, pero en un token OAuth: el conjunto de cosas que un usuario ha aceptado que tu app haga en su nombre. Un permiso es lo que tu clave puede hacer. Un scope es lo que un usuario te permitió hacer. Consulta la guía de OAuth.
El registro de que un usuario aprobó tu app para un conjunto de scopes.
Un componente de interfaz prediseñado que Whop ofrece y que insertas en tu propio producto, para que no tengas que construir la interfaz tú mismo.
Algo que ocurrió en una cuenta, como un pago que se completa correctamente.
La solicitud HTTP que Whop envía a tu servidor para indicarte que ocurrió un evento. Consulta Webhooks.

Comunidad

Una sala donde los miembros se envían mensajes entre sí. Consulta Chat.
Una publicación en un canal de chat o un mensaje directo.
Un espacio con hilos para publicaciones más largas, separado del chat en vivo. Consulta Foros.
Un hilo de un foro, con sus respuestas y sus reacciones.
Un mensaje enviado a un usuario dentro de Whop. Cada envío se limita a una experiencia o a un usuario. Consulta Notificaciones.

Publicidad

adcamp_
El contenedor de nivel superior para anuncios de pago en una red publicitaria. Establece la plataforma, el objetivo y la estrategia de presupuesto. Consulta Campañas publicitarias.
adgrp_
Se encuentra dentro de una campaña y controla la entrega: la segmentación, el objetivo de optimización y la programación. Consulta Grupos de anuncios.
ad_
La unidad creativa que entrega un grupo de anuncios: texto, recursos y la URL de destino. Consulta Anuncios.
Una lista de clientes subida a Whop y usada para incluir o excluir personas en un grupo de anuncios. Consulta Audiencias.

Referencias y recompensas

aff_
Alguien que gana una comisión por enviar compradores a un producto. Consulta Afiliados.
Un usuario inscrito en el programa de partners de Whop, que gana con los negocios que refiere a Whop. Consulta Partners.
coma_
Un negocio que un partner trajo a Whop, con las tasas de comisión y la ventana de referencia que se le aplican.
Una línea de comisión de un negocio referido, que indica la fuente de ingresos de la que proviene y su estado.
bnty_
Una tarea remunerada cuya recompensa se retiene en depósito de garantía desde el momento en que se publica. Consulta Recompensas.
btys_
El intento de un trabajador en una recompensa, desde el intento hasta la revisión y el pago.

Entornos y claves

Whop tiene dos entornos. No comparten nada. Consulta Prueba en el sandbox para saber cómo cambiar de entorno.
Las claves de sandbox y de producción tienen el mismo aspecto. Nada en la cadena de la clave indica a qué entorno pertenece, así que guárdalas con nombres diferentes y compruébalo antes de ejecutar cualquier cosa que mueva dinero.
Cinco tipos de credenciales acceden a la API. Elige según de quién son los datos que necesitas. Consulta Autenticación y claves de API para saber cómo elegir y limitar cada una.
El encabezado que fija tu integración a una versión fechada de la API, para que los cambios posteriores no alteren las respuestas con las que construiste. Consulta Versionado de la API.
Un valor que adjuntas a un POST para que, al reintentarlo, se reproduzca la respuesta original en lugar de hacer el trabajo dos veces. Consulta Solicitudes idempotentes.

Referencia de ID

Cada objeto tiene un ID con prefijo. Cuando estés mirando un payload, esta tabla te indica qué tienes delante.

Próximos pasos

Inicio rápido

Haz tu primera llamada a la API en pocos minutos.

Prueba en el sandbox

Pruébalo todo con datos de prueba antes de pasar a producción.

Descripción general de la API

Cómo funcionan las solicitudes, el versionado y la paginación.

Qué puedes crear

El mapa completo de capacidades y la guía para lo que estás creando.