Skip to main content
Whop tiene cinco tipos de credenciales. La que necesitas depende de a qué datos accedes y de dónde se ejecuta el código. Elige en esta tabla y luego limita el alcance de la credencial antes de acercarla a producción.

Claves de API

Una clave de API de cuenta autentica tu servidor como una cuenta. Una clave de API de app autentica tu app en todas las cuentas que la instalaron. Ambas son secretas: mantenlas en el servidor.

Crear una clave de API de cuenta

Usa una clave de API de cuenta cuando tu servidor actúe en nombre de tu propia cuenta y sus subcuentas. En la página Developer del panel, abre Account API Keys y selecciona Create. El inicio rápido te guía por el proceso en el sandbox.

Crear una clave de API de app

Usa una clave de API de app cuando crees una app y necesites acceder a los datos de las cuentas que la instalaron.
  1. En el panel, abre Apps.
  2. Selecciona Create app y ponle un nombre a tu app. Puedes cambiar el nombre más tarde.
  3. Tu clave es el valor oculto que sigue a WHOP_API_KEY en la sección Environment variables. Usa el botón para mostrarla y guárdala en un lugar seguro.

Tokens de usuario con alcance de cuenta

Un token de usuario con alcance de cuenta actúa como un usuario concreto dentro de una cuenta concreta. Tu servidor lo genera con tu clave de API y se lo entrega a tu cliente, de modo que tus usuarios acceden a Whop sin iniciar sesión nunca en Whop. Crea uno con POST /api/v1/access_tokens y pasa account_id, user_id y las acciones que quieres permitir:
account_id empieza por biz_ y user_id empieza por user_. Tu clave de API debe tener permiso para acceder a ambos. Los tokens caducan en una hora de forma predeterminada. Establece expires_at para cambiarlo, hasta un máximo de tres horas. Genéralos cuando los necesites en lugar de almacenarlos en caché.

Limitar el alcance de un token

scoped_actions es la lista de cosas que puede hacer el token. Cada entrada es una cadena de acción separada por dos puntos.
Si dejas scoped_actions vacío o lo omites, el token hereda todos los permisos de la credencial que lo genera. Un token entregado a un navegador tendría entonces todo el alcance de tu clave de API. Pasa siempre una lista explícita.
Una acción debe ser un subconjunto de los propios permisos de la credencial que genera el token. No puedes conceder lo que tu clave de API no tiene. Estas acciones aparecen hoy en las guías de Whop: La API no publica una lista fija, así que considera este el conjunto documentado y no el completo. El límite definitivo siempre son los propios permisos de la credencial que genera el token.

Tokens de acceso de cuenta

Un token de acceso de cuenta actúa como la propia cuenta, sin ningún usuario asociado. Crea uno con POST /api/v1/access_tokens pasando solo account_id y las scoped_actions que quieres permitir. Caduca con el mismo calendario que un token de usuario con alcance de cuenta. Úsalo cuando un cliente necesite el acceso de tu cuenta durante poco tiempo, como un componente incrustado, y no intervenga ningún usuario concreto. Los endpoints que actúan como un usuario, como los de notificaciones o preferencias, lo rechazan.

Tokens de usuario de iframe

Cuando tu app se muestra dentro de Whop, cada solicitud del mismo origen lleva un JWT de corta duración en la cabecera x-whop-user-token. Verificas su firma para saber quién hace la solicitud y luego compruebas qué puede ver. Los SDK de Python y Ruby incluyen una función auxiliar para ello. El SDK de TypeScript no, así que verifica el JWT tú mismo. Este token nunca lo generas tú. Lo envía Whop y tú lo validas. Consulta Autenticación.

Tokens de OAuth

Un token de OAuth representa a un usuario que inició sesión en Whop y aprobó tu app para un conjunto de alcances. A diferencia de una clave de API, su alcance está limitado por lo que puede hacer ese usuario concreto. Úsalo para Iniciar sesión con Whop y para actuar en nombre de un usuario sobre su propia cuenta. Consulta OAuth.

Lista de comprobación de alcance

Antes de que una credencial llegue a producción:
  • Pasa scoped_actions explícitas en cada token que generes. No confíes nunca en la herencia.
  • Asigna a las claves de API un conjunto de permisos personalizado en cuanto sepas a qué endpoints llamas, en lugar de dejarlas como Admin.
  • Mantén las claves de API en el servidor. Solo los tokens de usuario deben ir en un cliente.
  • Genera tokens de corta duración cuando los necesites en lugar de almacenar en caché tokens de larga duración.
  • Usa credenciales distintas para cada entorno y comprueba cuál tienes antes de ejecutar cualquier cosa que mueva dinero.

Próximos pasos

Inicio rápido

Crea una clave del sandbox y haz tu primera llamada.

Conceptos principales

Cómo se relacionan las cuentas, los usuarios y los permisos.

OAuth

El flujo completo de OAuth 2.1 y PKCE.

Probar en el sandbox

Prueba primero las credenciales con datos de prueba.