Skip to main content
Whop API는 예측 가능한 방식으로 연결되는 소수의 객체로 이루어져 있습니다. 이 페이지는 각 객체를 정의하며, 하나의 객체가 둘 이상의 이름으로 불리는 경우 이를 명확히 밝힙니다.

계정 및 신원

biz_
Whop의 비즈니스입니다. API 키, 상품, 웹훅, 자금을 소유합니다. 계정을 참고하세요.
user_
Whop 로그인이 있는 사람입니다. 사용자는 여러 계정에서 구매할 수 있으며, 계정 운영을 도울 수도 있습니다. 사용자를 참고하세요.
계정을 운영할 수 있는 액세스 권한을 부여받은 사용자입니다. 역할에 따라 할 수 있는 일이 결정됩니다. 팀 멤버를 참고하세요.
고객으로서의 사용자입니다: 계정이 판매하는 무언가에 대한 멤버십을 보유하고 있거나 보유했던 사람입니다. 멤버를 참고하세요.

하위 계정

마켓플레이스를 운영할 때 등록하고 대신 활동하는 계정입니다. 해당 계정을 대신하여 결제를 받고 지급합니다. 플랫폼 가이드에서는 이를 하위 판매자(sub-merchant)라고 부르기도 합니다. 두 용어는 같은 객체를 의미합니다. 플랫폼 빠른 시작에서 전체 흐름을 안내합니다.
계정이 지급을 받기 전에 통과해야 하는 신원 확인입니다. 개인은 고객 확인(KYC) 절차를 완료합니다. 비즈니스는 기업 확인(KYB) 절차를 완료합니다. 인증을 참고하세요.
idpf_
인증으로 생성된 확인된 신원 데이터의 기록입니다.

판매하는 것

계정은 상품을 판매합니다. 상품은 가격을 설정하는 하나 이상의 변형을 가지며, 구매자가 실제로 받는 경험과 연결됩니다.
prod_
계정이 판매하는 것입니다. 설명, 미디어, 구매자가 선택할 수 있는 변형을 보유합니다. 상품을 참고하세요.
plan_
자체 가격, 청구 형태, 재고, SKU, 속성을 가진 상품의 구매 가능한 구성 하나입니다. 변형 ID는 plan_ 접두사를 유지합니다. 변형을 참고하세요.
mem_
구매자가 결제하면 받는 것입니다. 사용자를 변형에 연결하며, 지금 액세스가 유효한지 알려주는 상태를 포함합니다. 멤버십을 참고하세요.

경험

계정이 판매하는 것 안에 있는 콘텐츠 또는 기능 단위입니다. 상품은 하나 이상의 경험에 연결되며, 해당 상품의 멤버십이 경험에 대한 액세스를 부여합니다. 이는 Whop에서 가장 플랫폼 고유한 명사이며, 이름만으로는 짐작할 수 없는 용어입니다. Whop 안에서 실행되는 앱을 빌드한다면, 경험은 앱이 렌더링되는 대상입니다. 앱 뷰를 참고하세요.

권한 부여

사용자가 지금 특정 항목을 사용할 수 있다는 기록입니다. 액세스는 질문이고, 권한 부여(entitlement)는 저장된 답입니다. 계정, 상품 또는 경험에 대해 확인하세요. 인증을 참고하세요.

자금 이동 방식

자금은 들어와서 어딘가에 머문 다음 나갑니다. 아래의 각 객체는 그 경로의 한 단계이며, 발생 순서대로 나열되어 있습니다.
ch_
구매에 대한 재사용 가능한 정의입니다: 어떤 변형을, 어떤 가격에, 어떤 리디렉션으로. 라이브 결제 페이지를 생성합니다. 체크아웃 구성을 참고하세요.
pay_
구매자에서 계정으로 자금을 이동하려는 한 번의 시도로, 성공 여부를 알려주는 상태를 포함합니다.
카드 네트워크 측에서 설명한 동일한 이벤트입니다. 문서에서는 두 용어를 모두 사용합니다. API 객체는 payment입니다.

원장

계정 자금의 모든 입금과 출금에 대한 누적 기록입니다. 계정이 보유한 것과 받을 것에 대한 신뢰할 수 있는 원천입니다. 자금은 다른 곳으로 가기 전에 먼저 원장에 들어옵니다. 원장 활동을 참고하세요.
지금 원장에 있으며 사용하거나 출금할 수 있는 금액입니다.
향후 환불 및 분쟁에 대비하여 Whop이 보류하는 잔액의 일부입니다. 일정에 따라 해제됩니다.
자금이 잔액에 도달하기 전에 공제되는 결제에 대한 Whop의 몫입니다.
Whop 외부에서 잔액에 추가된 자금입니다. 입금을 참고하세요.
잔액에서 Whop 외부의 은행 계좌나 지갑으로 나가는 자금입니다. 지급을 참고하세요.
외부를 거치지 않고 Whop 내부의 두 계정 간에 이동하는 자금입니다. 이체를 참고하세요.
지원되는 토큰, 체인 또는 지갑 대상 간의 잔액 전환입니다. 스왑을 참고하세요.
icrd_
계정 또는 사용자 잔액에서 지출하는 Whop 발급 가상 카드입니다. 카드를 참고하세요.
사용자가 시작하여 구매자에게 반환된 완료된 결제입니다.
구매자의 은행이 구매자를 대신하여 되돌린 결제입니다. 이의를 제기할 수 있습니다. 분쟁을 참고하세요.

Whop에서 빌드하기

이 문서에서 플랫폼은 두 가지를 의미합니다. 플랫폼으로서의 Whop은 연동하는 대상 제품입니다. 마켓플레이스 의미의 플랫폼은 하위 계정을 등록하고 그 판매액의 일부를 받는 여러분입니다. 주변 문장을 보면 어느 쪽을 의미하는지 알 수 있습니다.
app_
Whop 안에서 실행되며 마켓플레이스를 통해 사용자에게 도달하는 소프트웨어입니다. 앱을 참고하세요.
앱이 Whop 안에서 렌더링하는 하나의 화면입니다: 고객용 경험 뷰 또는 크리에이터용 대시보드 뷰. 앱 뷰를 참고하세요.
Whop이 자체 인터페이스에 앱 페이지를 임베드하는 방식입니다. 앱은 여러분의 서버에서 실행되며 Whop의 UI 프레임 안에서 렌더링됩니다. iframe을 참고하세요.
API 키가 행사할 수 있는 단일 기능입니다. 권한을 참고하세요.

스코프

권한과 같은 개념이지만 OAuth 토큰에 적용됩니다: 사용자가 앱이 자신을 대신하여 할 수 있도록 동의한 항목의 집합입니다. 권한은 키가 할 수 있는 것입니다. 스코프는 사용자가 허락한 것입니다. OAuth 가이드를 참고하세요.
사용자가 일련의 스코프에 대해 앱을 승인한 기록입니다.
Whop이 제공하는 사전 빌드된 UI 컴포넌트로, 자체 제품에 넣기만 하면 되므로 인터페이스를 직접 빌드할 필요가 없습니다.
결제 성공처럼 계정에서 발생한 일입니다.
이벤트가 발생했음을 알리기 위해 Whop이 서버로 보내는 HTTP 요청입니다. 웹훅을 참고하세요.

커뮤니티

멤버들이 서로 메시지를 보내는 공간입니다. 채팅을 참고하세요.
채팅 채널 또는 다이렉트 메시지의 게시물 하나입니다.
실시간 채팅과 별개로 더 긴 게시물을 위한 스레드형 공간입니다. 포럼을 참고하세요.
답글과 반응을 포함하는 포럼의 스레드 하나입니다.
Whop 안에서 사용자에게 푸시되는 메시지입니다. 각 전송은 하나의 경험 또는 한 명의 사용자를 대상으로 합니다. 알림을 참고하세요.

광고

adcamp_
광고 네트워크의 유료 광고를 위한 최상위 컨테이너입니다. 플랫폼, 목표, 예산 전략을 설정합니다. 광고 캠페인을 참고하세요.
adgrp_
캠페인 안에 있으며 게재를 제어합니다: 타기팅, 최적화 목표, 일정. 광고 그룹을 참고하세요.
ad_
광고 그룹이 게재하는 크리에이티브 단위입니다: 문구, 에셋, 목적지 URL. 광고를 참고하세요.
Whop에 업로드되어 광고 그룹에서 사람을 타기팅하거나 제외하는 데 사용되는 고객 목록입니다. 오디언스를 참고하세요.

추천 및 보상

aff_
상품에 구매자를 보내 커미션을 받는 사람입니다. 제휴를 참고하세요.
Whop 파트너 프로그램에 등록되어 Whop에 추천한 비즈니스로 수익을 얻는 사용자입니다. 파트너를 참고하세요.
coma_
파트너가 Whop에 데려온 비즈니스로, 적용되는 커미션 비율과 추천 기간을 포함합니다.
추천된 비즈니스에 대한 커미션 항목 하나로, 발생한 수입원과 상태를 명시합니다.
bnty_
게시되는 순간부터 보상이 에스크로에 보관되는 유료 작업입니다. 바운티를 참고하세요.
btys_
시도부터 검토, 지급까지 이어지는 바운티에 대한 한 작업자의 시도입니다.

환경 및 키

Whop은 두 가지 환경을 운영합니다. 두 환경은 아무것도 공유하지 않습니다. 전환 방법은 샌드박스에서 테스트하기를 참고하세요.
샌드박스 키와 프로덕션 키는 똑같이 생겼습니다. 키 문자열만으로는 어느 환경에 속하는지 알 수 없으므로, 서로 다른 이름으로 저장하고 자금을 이동하는 작업을 실행하기 전에 확인하세요.
다섯 가지 자격 증명 유형으로 API에 접근할 수 있습니다. 누구의 데이터가 필요한지에 따라 선택하세요. 각 자격 증명을 선택하고 범위를 지정하는 방법은 인증 및 API 키를 참고하세요.
연동을 날짜가 지정된 API 버전에 고정하여 이후 변경 사항이 기준으로 삼은 응답을 바꾸지 않도록 하는 헤더입니다. API 버전 관리를 참고하세요.
POST에 첨부하는 값으로, 재시도할 때 작업을 두 번 수행하는 대신 원래 응답을 재생합니다. 멱등성 요청을 참고하세요.

ID 레퍼런스

모든 객체에는 접두사가 붙은 ID가 있습니다. 페이로드를 보고 있을 때 이 표를 보면 무엇을 다루고 있는지 알 수 있습니다.

다음 단계

빠른 시작

몇 분 안에 첫 API 호출을 해보세요.

샌드박스에서 테스트하기

실제 서비스 전에 테스트 데이터로 모든 것을 시도해 보세요.

API 개요

요청, 버전 관리, 페이지네이션의 작동 방식.

만들 수 있는 것

전체 기능 맵과 빌드하려는 것에 대한 가이드.