📑 Open API 사용 가이드

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

회원가입

프로젝트 생성을 위해 아래 링크에서 회원가입 후 계정을 생성해주세요. 회원가입 시 이메일 주소의 인증이 진행되며, 별도의 승인 절차는 없습니다.

💬 '회원가입' 하러가기

프로젝트 생성

회원가입 후 로그인을 했다면, 홈페이지 우측 상단의 '나의 대시보드'에서 프로젝트 생성을 클릭하여 나만의 프로젝트를 생성하세요. 프로젝트의 생성은 별도의 승인 없이 즉시 완료되어 테스트를 진행할 수 있습니다.

프로젝트 생성 시 테스트하고 싶은 API 상품 패키지를 선택합니다. 어떤 API 상품 패키지를 선택할 지 모르겠다면 [도입 문의]를 통해 컨설팅을 요청해보세요.

생성된 프로젝트는 '나의 대시보드'에서 확인할 수 있으며, 프로젝트를 클릭하면 프로젝트를 위한 상세 정보를 확인할 수 있습니다. 상제 정보를 통해 KONA PLATE플랫폼과의 연동을 위한 개발 리소스를 확인하세요.

| Step2 . 테스트 환경 구축

보안 인증키 발급 및 준비

프로젝트는 테스트의 목적에 따라 네 가지의 인증 키를 제공합니다. 각 인증키의 엑세스 키와 시크릿 키를 활용하여 API를 호출하기 위한 헤더에 포함합니다.

엔드포인트(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

공통 HTTP 헤더 설정

KONA PLATE 플랫폼으로 전송하는 HTTP 헤더에는 API 요청과 요청 관련 메타 정보 데이터가 포함되어 있습니다. 프로젝트 상세 페이지에서 확인할 수 있는 ASP ID와 암복호화 키 등 보안 인증 정보가 포함됩니다.

| Step3 . 연동 개발 테스트

기본 테스트 시나리오

실물 카드 결제 테스트

잔액을 보유한 카드가 준비되었다면 실물 카드를 활용한 결제 테스트가 진행됩니다.

그 외 코어 API

시나리오 이외의 코어 API에 대한 상세한 가이드는 [코어 API 페이지]에서 확인할 수 있습니다.

| Step4 . 서비스 오픈 준비

서비스 오픈을 위해 연동 개발이 최종적으로 완료되었는지 최종 점검이 필요합니다. KONA PLATE 플랫폼과의 연동 개발 최종 점검 단계인 UAT 테스트가 완료되었다면 UAT 리포트를 다운 받을 수 있습니다. 통과된 UAT 리포트를 바탕으로 KONA PLATE 담당자에게 서비스 오픈을 요청하세요.