Skip to main content
Utilisez OAuth 2.1 + PKCE avec OpenID Connect (OIDC) pour permettre aux utilisateurs de se connecter avec Whop sur votre site web ou votre app. Les jetons d’accès renvoyés vous permettent d’accéder aux données et d’agir au nom de ces utilisateurs.
Les endpoints OAuth se trouvent à l’adresse https://api.whop.com/oauth/.

Étape 1 : Créer votre app OAuth

L’objet App renvoyé par apps.create dans la version actuelle de @whop/sdk n’expose pas de champ client_secret. Copiez plutôt le secret client depuis l’onglet Dashboard.
Utilisez l’endpoint Create App pour créer une app OAuth par programmation :
Mettez à jour les URI de redirection plus tard avec l’endpoint Update App.

Étape 2 : Rediriger les utilisateurs vers l’autorisation

Dans votre client web ou mobile, utilisez PKCE pour rediriger de manière sécurisée les utilisateurs vers le flux OAuth de Whop.
Appelez startWhopOAuth pour rediriger l’utilisateur :
Si l’utilisateur n’est pas connecté, Whop lui demande de se connecter, puis affiche l’écran de consentement. Si l’utilisateur a déjà approuvé votre application pour les scopes demandés, il est automatiquement redirigé sans avoir à confirmer une seconde fois.
Si vous passez un ID de compte en tant que company_id, les jetons sont limités à ce compte pour l’utilisateur. Vous ne pouvez accéder qu’aux ressources que l’utilisateur peut contrôler sur ce compte Whop.

Étape 3 : Gérer le callback et échanger le code

Whop redirige vers votre redirect_uri avec code et state. Utilisez cette fonction pour vérifier le state, échanger le code contre des jetons et récupérer les identifiants :
Sur votre page de callback :

Étape 4 : Utiliser les jetons

Initialisez le SDK Whop avec le jeton d’accès de l’utilisateur :
Consultez la référence API pour voir tous les endpoints disponibles.

Étape 5 : Rafraîchir les jetons

Les jetons d’accès expirent au bout d’une heure. Utilisez le jeton de rafraîchissement pour obtenir de nouveaux identifiants :
Utilisation :
Les jetons de rafraîchissement changent à chaque utilisation. Stockez toujours les nouveaux jetons renvoyés par l’endpoint de rafraîchissement. Si vous avez fourni company_id lors de l’autorisation, vous devez fournir le même company_id lors du rafraîchissement.

Étape 6 : Userinfo et révocation

Obtenir les informations de l’utilisateur

Récupérez le profil de l’utilisateur authentifié avec l’endpoint userinfo :
Les champs renvoyés dépendent des scopes accordés. openid est requis, profile ajoute le nom, le nom d’utilisateur et la photo, email ajoute les champs d’e-mail.

Révoquer les jetons à la déconnexion

Lorsqu’un utilisateur se déconnecte, révoquez son jeton de rafraîchissement. Les jetons d’accès expirent au bout d’une heure et ne peuvent pas être révoqués côté serveur.
Révoquez toujours les jetons lorsque les utilisateurs se déconnectent. Cela invalide immédiatement le jeton de rafraîchissement, ce qui empêche tout accès non autorisé même si le jeton a été compromis.

Gestion des erreurs

Les erreurs OAuth suivent le format standard :
Codes d’erreur courants :
  • invalid_request : paramètre manquant ou invalide.
  • invalid_grant : code ou jeton expiré ou révoqué.
  • invalid_client : client_id inconnu.
  • insufficient_scope : le jeton ne dispose pas du scope requis.
  • rate_limit_exceeded : trop de requêtes (vérifiez l’en-tête Retry-After).

Étapes suivantes

Référence API

Tous les endpoints qu’un jeton d’accès accordé peut appeler.

Accepter des paiements

Associez la connexion au checkout pour des parcours d’achat de bout en bout.

Écouter les webhooks

Réagissez côté serveur aux événements de paiement, d’adhésion et d’inscription.

Demander des autorisations

Configurez les scopes OAuth dont votre app a réellement besoin.