토스페이먼츠 API 키는 클라이언트 및 서버 요청을 확인하고 인증하는 역할을 해요. 요청자의 인증 정보를 확인하고 토스페이먼츠는 요청에 따른 올바른 응답을 내려줘요.
-
토스페이먼츠 개발자센터에 회원가입하세요. PG 계약, 사업자번호 없이 이메일 주소만으로 토스페이먼츠에 회원가입할 수 있어요.
-
토스페이먼츠 PG 계약을 완료했다면, 상점을 선택하세요. PG 계약 전이라면 개발 연동 체험 상점의 테스트 키만 확인할 수 있어요.
-
개발자센터의 API 키 메뉴를 들어가서 필요한 키를 확인하세요.
-
다른 사람에게 API 키를 공유해야 된다면 화면 왼쪽 하단에 있는 '사용자 추가하기'를 눌러서 권한을 추가하세요.
로그인한 상태로 개발자센터 문서를 보면, 코드 예제의 키 값이 내 개발 연동 체험 상점 키로 바뀌어요. 테스트 결제내역, 웹훅을 사용해보세요.
테스트 키는 test
로 시작해요. 테스트 환경에서는 실제 결제 정보(카드 번호, 휴대폰 번호 등)를 사용해도 결제 승인은 가상으로 이루어져요. 결제수단에서 금액이 차감되지 않아요. 개발 연동 체험 상점의 테스트 키는 PG 계약 전에도 발급돼요.
라이브 키는 live
로 시작해요. 실제로 운영할 서비스에 사용하세요. 결제 승인이 실제로 이루어져요. 라이브 키는 토스페이먼츠 PG 계약 이후에 발급돼요.
개발 연동 체험 상점의 테스트 키를 사용하면 모든 결제수단을 연동해볼 수 있어요. 계약 이후 발급된 내 상점의 테스트 키는 토스페이먼츠와 계약된 결제수단만 연동할 수 있어요. 예를 들어, 카드 결제만 계약했는데 가상계좌 결제를 요청하면 에러가 납니다.
클라이언트 키와 시크릿 키는 항상 ‘세트’로 묶여 있고, 한 세트로 써야 돼요. 세트가 아닌 키를 사용하거나 테스트 또는 라이브 키를 섞어 사용하면 INVALID_API_KEY
오류가 발생해요.
클라이언트 키는 브라우저에서 토스페이먼츠 SDK를 초기화할 때 사용해요. 내 상점의 계약 정보, 결제위젯 설정을 불러와요. 결제위젯 클라이언트 키는 중간에 gck
가 있고, API 개별 연동 키는 중간에 ck
가 있어요.
시크릿 키는 토스페이먼츠 API를 호출할 때 사용해요. ID와 비밀번호 대신 시크릿 키로 API 요청을 인증해요. 결제위젯 시크릿 키는 중간에 gsk
가 있고, API 개별 연동 키는 중간에 sk
가 있어요.
- 시크릿 키를 사용하는 방법은 인증 가이드에서 확인하세요.
- 시크릿 키는 외부에 노출되면 안 돼요. GitHub, 클라이언트 코드 등 외부에 보이는 곳에 추가하지 마세요.
그래서 어떤 키를 사용하면 되나요? 간단히 말하자면 결제위젯 SDK를 사용하면 결제위젯 연동 키를 사용하고, 결제창・브랜드페이 SDK를 사용하면 API 개별 연동 키를 사용하세요.
클라이언트 키
결제위젯 SDK를 초기화할 때 사용하세요. 일반 결제, 브랜드페이, 해외결제 서비스를 함께 사용해도 클라이언트 키는 하나만 필요해요.
시크릿 키
사용 방법
클라이언트 키, 시크릿 키를 복사하고 바로 결제위젯 연동을 시작하세요.
클라이언트 키
시크릿 키
사용 방법
1. 연동하는 결제 서비스의 상점아이디(MID)를 선택하세요.
2. 사용하고 싶은 API 버전을 선택하세요. 각 버전에 대한 정보는 릴리즈 노트 > API 업데이트에서 확인하세요.
3. 클라이언트 키, 시크릿 키를 복사해서 사용하세요.
상태 코드 | 에러 코드 | 에러 메시지 | 해결 방법 |
---|---|---|---|
400 | INVALID_CLIENT_KEY | 잘못된 클라이언트 연동 정보입니다. | 클라이언트 키 값을 다시 확인해주세요. |
400 | INVALID_API_KEY | 잘못된 시크릿 키 연동 정보입니다. | 클라이언트 키와 매칭된 시크릿 키를 사용하고 있는지 확인하세요. |
401 | UNAUTHORIZED_KEY | 인증되지 않은 시크릿 키 혹은 클라이언트 키입니다. | 클라이언트 키와 매칭된 시크릿 키를 사용하고 있는지 확인하세요. 시크릿 키 인코딩을 다시 확인하세요. |
401 | INCORRECT_BASIC_AUTH_FORMAT | 잘못된 요청입니다. : 를 포함해 인코딩해주세요. | 시크릿 키 인코딩을 다시 확인하세요. |