퀵 스타트 가이드

이 페이지는 KONA PLATE 플랫폼과 가장 빠르게 연동할 수 있는 방법을 안내합니다.

아래 절차에 따라 연동과 테스트가 완료되었다면, KONA PLATE 운영자에게 도입 문의를 통한 컨설팅 혹은 서비스 오픈을 요청하세요.

Step1) 회원 가입 및 프로젝트 생성

1. 회원가입

프로젝트 생성을 위해 KONA PLATE 홈페이지의 계정을 만드려면 아래 링크를 클릭하세요.

https://www.konaplate.com/user/registration

KONA PLATE 홈페이지 회원 가입은 간단한 회원 정보로 신속하게 가능하며, 계정의 활성화를 위해서는 가입할 때 사용한 이메일 주소의 인증이 반드시 필요합니다.

회원 가입은 별도 승인 절차가 존재하지 않습니다.

2. 프로젝트 생성

만약, 계약을 체결한 제휴사라면 KONA PLATE 운영자에게 프로젝트 생성을 요청하세요. : 프라이빗 샌드박스

계약을 체결하지 않더라도, KONA PLATE 플랫폼에서 프로젝트를 생성하고 API를 테스트 할 수 있습니다. : 공용 샌드박스

* 일부 API 혹은 테스트는 제한될 수 있습니다.

[대시보드] 에서 프로젝트 생성을 클릭하여, 나만의 프로젝트를 생성하세요.

프로젝트의 생성은 별도의 승인 없이 즉시 완료되어 테스트를 진행할 수 있습니다.

프로젝트 생성 시, 테스트해보고자 하는 API 상품 패키지를 선택합니다.

어떤 API 상품 패키지를 선택할지 모르시겠다면 [KONA PLATE 소개] 페이지를 확인하거나 [도입 문의]를 통해 컨설팅을 요청해보세요.

생성된 프로젝트는 [대시보드]에서 확인할 수 있으며, 프로젝트를 클릭하면 프로젝트를 위한 자세한 정보를 확인할 수 있습니다.

[프로젝트 상세] 에서 KONA PLATE 플랫폼과의 연동을 위한 개발 리소스들을 확인하세요.

Step2) 테스트 환경 구축 바로가기 →

1. 보안 인증 키 발급 및 준비

KONA PLATE 프로젝트는 테스트의 목적에 따라 아래와 같이 네 가지 인증 키를 제공합니다.

각 인증 키의 액세스 키와 시크릿 키를 활용하여 API를 호출하기 위한 헤더에 포함됩니다.

보안 인증 키	설명
데이터 암호화 키	KONA PLATE 플랫폼과 연동하기 위해서는 통신하는 데이터의 암복호화 절차가 필요합니다. API 통신 시, 헤더에 필수로 입력해야 하는 암복호화를 위한 인증 키 입니다.
MOCK 키	준비된 테스트 데이터를 기반으로, 단일 API 테스트를 위한 인증 키 입니다. 해당 인증 키는 MOCK 서버와 연동되며, 테스트 절차나 시나리오는 무시됩니다.
API 키	자체 개발 완료 후, KONA PLATE와 연동 테스트하기 위한 인증 키 입니다. 카드 결제 테스트 등 제공되는 시나리오를 따라, 다양한 케이스에서 API를 테스트 하세요.
UAT 키	연동 개발 최종 점검인 UAT 테스트를 위해 사용되는 인증 키 입니다.

2. 엔드포인트(API 요청 URL)설정

샌드박스 환경으로의 연동 시 Base URL은 아래와 같습니다.

https://sandbox.konaplate.com/open-api

테스트하고자 하는 API와 API 문서를 확인하여, Base URL에 엔드포인트 URI를 추가 삽입합니다.

회원 가입 API URI : /open-api/api/v1/user/registration
엔드포인트 URL : https://sandbox.konaplate.com/open-api/api/v1/user/registration

3. 공통 HTTP 헤더 설정

KONA PLATE 플랫폼으로 전송하는 HTTP 헤더에는, API 요청과 요청 관련 메타 정보 데이터가 포함되어 있습니다.

프로젝트 상세 페이지에서 확인할 수 있는 ASP ID와 암복호화 키 등 보안 인증 정보가 포함됩니다.

공통 HTTP 헤더 항목	설명	설정 필요 값	예시
X-KM-User-AspId	ASP ID	ASP ID는 서비스 단위 별 제공되는 구분 ID 값 입니다. 공용 샌드박스 프로젝트인 경우에는, 모든 프로젝트에 동일한 ASP ID 값이 부여됩니다. 계약이 완료된 프라이빗 샌드박스 프로젝트인 경우에는, 전용 ASP 값이 부여됩니다.	000170000000000
X-KM-Correlation-Id	전문 추적 거래번호	전문 추적을 위한 거래번호 입니다. yyMMddHHmiSS-xxxxxxx (xxxxxxx : 7자리, Hex String)	2203260931333-1234567
X-KM-Access-Key	프로젝트 액세스 키	프로젝트 인증 키로, 테스트 목적 별로 변동됩니다. MOCK 테스트, KONA PLATE 플랫폼 연동 테스트, UAT 테스트 [프로젝트 보안 인증] 에서 키 확인하기	6167e69-82e76da0a26bc9949840b395ab41261c
X-KM-Crypto-Key-Id	데이터 암복호화 키	요청 정보의 데이터를 암복호화하기 위한 키 입니다. 데이터 암호화가 필요한 API 요청 시 필수 입력 값입니다. (Data Encryption = Y) [데이터 암복호화] 에서 더 자세한 내용 확인하기 [프로젝트 보안 인증] 에서 키 확인하기	73968349bf47510038045863ec6352e9
X-KM-Tran-Token	데이터 무결성 확인 키	프로젝트의 시크릿 키를 활용하여 데이터 무결성을 확인하기 위한 키입니다. Tran Token : "KMV1:" + yyyyMMddhh24misssss + ":" + SHA256HMAC(secret key, request body String) [데이터 무결성 확인 : Tran-Token] 에서 더 자세한 내용 확인하기 [프로젝트 보안 인증] 에서 키 확인하기	KMV1:20220921121907111:C1BcAL4jfE /XixZYBjcPG2GL1yuTrzSdGAht73P1of0=
X-KM-Tran-Time	클라이언트 요청 시간	yyyyMMddHH24mmss	202203260931333
X-KM-Time-Zone	시간대 정보	KST, UTC	KST

Step3) 연동 개발 테스트 바로가기 →

KONA PLATE 플랫폼의 연동 개발 테스트를 위한 기본적인 테스트 시나리오 입니다.

제공되는 테스트 데이터를 바탕으로, 각 단계 별 테스트에 필수적으로 필요한 사항이나 선행되어야 하는 내용을 소개합니다.

1. 기본 테스트 시나리오

	연동 개발 시나리오	설명	테스트 데이터
1	회원 가입	회원가입API를 통해 제휴사 회원을 KONA PLATE 플랫폼의 회원으로 회원 가입하는 절차입니다. 시나리오를 위해 제공되는 회원 데이터 로의 회원 가입 처리가 필요합니다.	회원 데이터
2	카드 신청	카드신청API를 통해 사용하고자 하는 카드를 신청하는 절차입니다. 프로젝트가 생성된 경우, 테스트에 활용할 수 있는 카드가 자동으로 발급됩니다. 발급 카드 데이터가 보이지 않는 경우, KONA PLATE 담당자에게 문의하세요.	발급 카드 데이터
3	계좌 등록	계좌등록API를 통해 회원에게 은행 계좌를 등록하는 절차로, 등록된 계좌로 본인 인증 및 은행 계좌 충전이 가능합니다. 시나리오를 위해 제공되는 은행 계좌 데이터 로의 계좌 등록 처리가 필요합니다.	은행 계좌 데이터
4	카드 등록	카드등록API를 통해 발급된 카드를 회원과 연결하는 절차 입니다. 프로젝트가 생성된 경우, 테스트에 활용할 수 있는 카드가 자동으로 발급됩니다. 발급 카드 데이터가 보이지 않는 경우, KONA PLATE 담당자에게 문의하세요.	발급 카드 데이터
5	은행 계좌 충전	은행계좌충전API를 통해 회원과 연결된 계좌로, 회원과 연결된 카드의 잔액을 충전하는 절차 입니다.	은행 계좌 데이터 발급 카드 데이터

2. 실물 카드 결제 테스트

잔액을 보유한 카드가 준비되었다면, 카드를 활용한 결제 테스트 단계 입니다.

	연동 개발 시나리오	설명	테스트 데이터
6	결제 승인 요청	[카드 결제 테스트] 를 통해 결제 승인을 요청하는 절차입니다. 제공되는 가맹점 데이터 를 활용하여 결제 테스트가 가능합니다.	가맹점 데이터
7	거래내역 조회	거래내역조회API를 통해 발생한 정상적으로 처리된 결제 내역을 확인할 수 있습니다.
8	결제 승인 취소 요청	[카드 결제 테스트] 를 통해 결제 승인 취소를 요청하는 절차입니다. 제공되는 가맹점 데이터 를 활용하여 결제 테스트가 가능합니다.	거래내역 데이터 가맹점 데이터

3. 그 외 코어 API

시나리오 이외의 코어 API에 대한 상세한 시나리오와 가이드는 API 상세 가이드에서 확인하실 수 있습니다.

[코어 API] 페이지를 통해 제공되는 API와 절차 및 시나리오를 확인하세요!

Step4) 서비스 오픈 준비 바로가기 →

서비스 오픈을 위해서 연동 개발이 최종적으로 완료되었는지 최종 점검이 필요합니다.

KONA PLATE 플랫폼과의 연동 개발 최종 점검 단계인 [UAT 테스트]가 완료된 경우, UAT 리포트를 다운 받을 수 있습니다.

통과 완료된 UAT 리포트를 바탕을 KONA PLATE 담당자에게 서비스 오픈을 요청하세요.