API 키
캔디페이 API 키는 클라이언트 및 서버 요청을 확인하고 인증하는 역할을 해요. 요청자의 인증 정보를 확인하고 캔디페이는 요청에 따른 올바른 응답을 내려줘요.
API 키 확인하기
개발자센터의 API 키 메뉴(현재 개발중)에서 API 개별 연동 키를 확인하세요.
// API 개별 테스트 연동 키 예시
// 참고) 이 테스트 키로도 테스트를 해볼 수 있습니다.
const clientKey = "test_ck_CANDYwX7K8mYw1lj05m8yQxzvNPG";
const secretKey = "test_sk_CANDYOvk5rkmL1lBDMq3n07xlzmj";API 키 이해하기
테스트 키와 라이브 키
테스트 키는 test로 시작해요. 테스트 환경에서는 실제 결제 정보(카드 번호, 휴대폰 번호 등)를 사용해도 결제 승인은 가상으로 이루어져요. 결제수단에서 금액이 차감되지 않아요.
라이브 키는 live로 시작해요.
클라이언트 키와 시크릿 키
클라이언트 키와 시크릿 키는 항상 ‘세트’로 묶여 있고, 한 세트로 써야 돼요.
세트가 아닌 키를 사용하거나 테스트 또는 라이브 키를 섞어 사용하면 INVALID_API_KEY 오류가 발생해요.
클라이언트 키는 브라우저에서 캔디페이 SDK를 초기화할 때 사용해요. 내 상점의 계약 정보, 결제창 설정을 불러와요. 중간에 ck가 있어요.
시크릿 키는 캔디페이 API를 호출할 때 사용해요. ID와 비밀번호 대신 시크릿 키로 API 요청을 인증해요. 중간에 sk가 있어요.
- 시크릿 키는 외부에 노출되면 안 돼요. GitHub, 클라이언트 코드 등 외부에 보이는 곳에 추가하지 마세요.
시크릿 키 사용하기
- 개발자센터(현재 개발중)에서 내 시크릿 키를 확인할 수 있어요.
test_sk_CANDYOvk5rkmL1lBDMq3n07xlzmj- 시크릿 키 뒤에
:을 추가하고 base64로 인코딩하세요. 콜론을 빠트리지 않도록 주의하세요.
echo -n 'test_sk_CANDYOvk5rkmL1lBDMq3n07xlzmj:' | base64- 인코딩된 값을 API의 Basic 인증헤더에 사용하세요.
Authorization: Basic {ENCODED_SECRET_KEY}참고) Basic 인증 이해
Authorization: Basic base64({USERNAME}:{PASSWORD})HTTP Basic 인증 방식 은 클라이언트에서 base64로 인코딩된 사용자 ID, 비밀번호 쌍을 인증 정보(credentials) 값으로 사용합니다. 사용자 ID와 비밀번호는 위와 같이 콜론으로 구분합니다. Base64로 인코딩한 정보는 쉽게 디코딩이 가능해서 Basic 인증은 반드시 HTTPS 및 TLS와 함께 사용해야 합니다.
캔디페이 API는 시크릿 키를 사용자 ID로 사용하고, 비밀번호는 사용하지 않습니다. 비밀번호가 없다는 것을 알리기 위해 시크릿 키 뒤에 콜론을 추가합니다.