Skip to main content
OAuth 2.1 + PKCE와 OpenID Connect(OIDC)를 사용하여 사용자가 웹사이트나 앱에서 Whop으로 로그인하도록 하세요. 반환된 액세스 토큰으로 데이터에 접근하고 해당 사용자를 대신해 작업을 수행할 수 있습니다.
OAuth 엔드포인트는 https://api.whop.com/oauth/에 있습니다.

1단계: OAuth 앱 만들기

현재 @whop/sdk의 apps.create가 반환하는 App 객체는 client_secret 필드를 노출하지 않습니다. 대신 Dashboard 탭에서 클라이언트 시크릿을 복사하세요.
Create App 엔드포인트를 사용하여 프로그래밍 방식으로 OAuth 앱을 만드세요:
나중에 Update App 엔드포인트로 리디렉션 URI를 업데이트할 수 있습니다.

2단계: 사용자를 권한 부여로 보내기

웹 또는 모바일 클라이언트에서 PKCE를 사용하여 사용자를 Whop의 OAuth 흐름으로 안전하게 리디렉션하세요.
startWhopOAuth를 호출하여 사용자를 리디렉션하세요:
사용자가 로그인하지 않은 경우 Whop이 로그인을 요청한 다음 동의 화면을 표시합니다. 사용자가 요청된 범위에 대해 이미 애플리케이션을 승인한 경우, 두 번 확인할 필요 없이 자동으로 다시 리디렉션됩니다.
계정 ID를 company_id로 전달하면 토큰은 해당 사용자의 그 계정으로 범위가 제한됩니다. 사용자가 해당 Whop 계정에서 제어할 수 있는 리소스에만 접근할 수 있습니다.

3단계: 콜백 처리 및 코드 교환하기

Whop은 code와 state를 포함하여 redirect_uri로 다시 리디렉션합니다. 이 함수를 사용하여 state를 검증하고, 코드를 토큰으로 교환하고, 자격 증명을 가져오세요:
콜백 페이지에서:

4단계: 토큰 사용하기

사용자의 액세스 토큰으로 Whop SDK를 초기화하세요:
사용 가능한 모든 엔드포인트는 API 레퍼런스에서 확인하세요.

5단계: 토큰 갱신하기

액세스 토큰은 1시간 후에 만료됩니다. 리프레시 토큰을 사용하여 새 자격 증명을 받으세요:
사용법:
리프레시 토큰은 사용할 때마다 교체됩니다. 갱신 엔드포인트에서 반환된 새 토큰을 항상 저장하세요. 권한 부여 시 company_id를 제공했다면 갱신할 때도 동일한 company_id를 제공해야 합니다.

6단계: Userinfo 및 취소

사용자 정보 가져오기

userinfo 엔드포인트를 사용하여 인증된 사용자의 프로필을 가져오세요:
반환되는 필드는 부여된 범위에 따라 다릅니다. openid는 필수이며, profile은 이름/사용자 이름/사진을, email은 이메일 필드를 추가합니다.

로그아웃 시 토큰 취소하기

사용자가 로그아웃하면 리프레시 토큰을 취소하세요. 액세스 토큰은 1시간 후에 만료되며 서버에서 취소할 수 없습니다.
사용자가 로그아웃할 때는 항상 토큰을 취소하세요. 이렇게 하면 리프레시 토큰이 즉시 무효화되어, 토큰이 유출되더라도 무단 액세스를 방지할 수 있습니다.

오류 처리

OAuth 오류는 표준 형식을 따릅니다:
일반적인 오류 코드:
  • invalid_request: 매개변수가 누락되었거나 유효하지 않습니다.
  • invalid_grant: 코드 또는 토큰이 만료되었거나 취소되었습니다.
  • invalid_client: 알 수 없는 client_id입니다.
  • insufficient_scope: 토큰에 필요한 범위가 없습니다.
  • rate_limit_exceeded: 요청이 너무 많습니다(Retry-After 헤더를 확인하세요).

다음 단계

API 레퍼런스

부여된 액세스 토큰으로 호출할 수 있는 모든 엔드포인트입니다.

결제 받기

로그인과 체크아웃을 결합하여 엔드 투 엔드 구매 흐름을 만드세요.

웹훅 수신하기

서버 측에서 결제, 멤버십, 입장 이벤트에 대응하세요.

권한 요청하기

앱에 실제로 필요한 OAuth 범위를 구성하세요.