Skip to main content
Whop propose cinq types d’identifiants. Celui dont vous avez besoin dépend des données auxquelles vous accédez et de l’endroit où s’exécute le code. Choisissez dans ce tableau, puis restreignez l’identifiant avant qu’il n’approche la production.

Clés API

Une clé API de compte authentifie votre serveur en tant que compte. Une clé API d’application authentifie votre application sur chaque compte qui l’a installée. Les deux sont des secrets : conservez-les côté serveur.

Créer une clé API de compte

Utilisez une clé API de compte lorsque votre serveur agit pour votre propre compte et ses sous-comptes. Dans la page Developer du tableau de bord, ouvrez Account API Keys et sélectionnez Create. Le démarrage rapide décrit la procédure dans le sandbox.

Créer une clé API d’application

Utilisez une clé API d’application lorsque vous créez une application et devez accéder aux données des comptes qui l’ont installée.
  1. Dans le tableau de bord, ouvrez Apps.
  2. Sélectionnez Create app et donnez un nom à votre application. Vous pourrez le modifier plus tard.
  3. Votre clé est la valeur masquée après WHOP_API_KEY dans la section Environment variables. Utilisez le bouton d’affichage pour la révéler, puis conservez-la en lieu sûr.

Jetons utilisateur limités à un compte

Un jeton utilisateur limité à un compte agit en tant qu’utilisateur précis au sein d’un compte précis. Votre serveur le génère avec votre clé API et le transmet à votre client, afin que vos utilisateurs accèdent à Whop sans jamais se connecter à Whop. Créez-en un avec POST /api/v1/access_tokens, en transmettant account_id, user_id et les actions que vous souhaitez autoriser :
account_id commence par biz_ et user_id commence par user_. Votre clé API doit être autorisée à accéder aux deux. Les jetons expirent par défaut au bout d’une heure. Définissez expires_at pour modifier cette durée, dans la limite de trois heures. Générez-les à la demande plutôt que de les mettre en cache.

Restreindre un jeton

scoped_actions est la liste des opérations autorisées pour le jeton. Chaque entrée est une chaîne d’action dont les parties sont séparées par des deux-points.
Si vous laissez scoped_actions vide ou l’omettez, le jeton hérite de toutes les permissions de l’identifiant qui l’a généré. Un jeton transmis à un navigateur dispose alors de toute la portée de votre clé API. Transmettez toujours une liste explicite.
Une action doit faire partie des permissions de l’identifiant qui génère le jeton. Vous ne pouvez pas accorder ce que votre clé API ne possède pas. Ces actions apparaissent aujourd’hui dans les guides Whop : L’API ne publie pas de liste fixe : considérez donc cette liste comme l’ensemble documenté plutôt que comme l’ensemble complet. La limite qui fait foi reste toujours les permissions de l’identifiant qui génère le jeton.

Jetons d’accès au compte

Un jeton d’accès au compte agit en tant que compte lui-même, sans utilisateur associé. Créez-en un avec POST /api/v1/access_tokens, en transmettant uniquement account_id et les scoped_actions à autoriser. Il expire selon le même calendrier qu’un jeton utilisateur limité à un compte. Utilisez-le lorsqu’un client a besoin de l’accès de votre compte pendant une courte durée, par exemple pour un composant intégré, sans qu’aucun utilisateur précis ne soit impliqué. Les endpoints qui agissent en tant qu’utilisateur, comme ceux des notifications ou des préférences, le refusent.

Jetons utilisateur iframe

Lorsque votre application s’affiche dans Whop, chaque requête de même origine contient un JWT de courte durée dans l’en-tête x-whop-user-token. Vous vérifiez sa signature pour savoir qui fait la demande, puis vous contrôlez ce que cette personne peut voir. Les SDK Python et Ruby fournissent une fonction utilitaire pour cela. Ce n’est pas le cas du SDK TypeScript : vérifiez donc le JWT vous-même. Vous ne générez jamais ce jeton. Whop l’envoie, et vous le validez. Consultez Authentification.

Jetons OAuth

Un jeton OAuth représente un utilisateur qui s’est connecté à Whop et a approuvé votre application pour un ensemble de scopes. Contrairement à une clé API, sa portée est limitée à ce que cet utilisateur peut faire. Utilisez-le pour Sign in with Whop et pour agir au nom d’un utilisateur sur son propre compte. Consultez OAuth.

Liste de contrôle des restrictions

Avant qu’un identifiant n’atteigne la production :
  • Transmettez des scoped_actions explicites pour chaque jeton généré. Ne comptez jamais sur l’héritage.
  • Attribuez aux clés API un ensemble de permissions personnalisé dès que vous savez quels endpoints vous appelez, plutôt que de les laisser en Admin.
  • Conservez les clés API côté serveur. Seuls les jetons utilisateur ont leur place dans un client.
  • Générez des jetons de courte durée à la demande au lieu de mettre en cache des jetons de longue durée.
  • Utilisez des identifiants distincts pour chaque environnement, et vérifiez celui que vous utilisez avant d’exécuter toute opération qui déplace de l’argent.

Étapes suivantes

Démarrage rapide

Créez une clé sandbox et effectuez votre premier appel.

Concepts clés

Comment les comptes, les utilisateurs et les permissions sont liés.

OAuth

Le flux complet OAuth 2.1 et PKCE.

Tester dans le sandbox

Essayez d’abord vos identifiants sur des données de test.