개발 가이드
- Quick Start Guide
- 프로젝트 준비
- 프로젝트 시작
자격인증
- KONA PLATE의 프로젝트를 생성할 경우, API 테스트를 위해 발급되는 프로젝트 키와 인증서를 의미합니다.
1. 암호화 키
- 암호화 키
연동 API 중에서 입/출력 데이터에 민감한 정보가 있을 경우, 데이터를 암호화 하기 위해 사용되는 키 입니다. - 암호화 키 생성
제휴사에서 요청한 프로젝트에 대해, 관리자가 승인 시, 제휴사 사용 API 중에서 데이터 암복호화가 필요한 API가 존재할 경우, 암호화 키가 발급됩니다. - 암호화 키 타입
- 서버 키 : 제휴사는 API 의 암복호화 방식에 따라, 서버의 공개키를 데이터 암호화에 사용합니다.
- 클라이언트 키 : 제휴사는 API 의 암복호화 방식에 따라, 클라이언트의 개인키를 데이터 복호화에 사용합니다.
2. 프로젝트 키
- 제휴사는 API의 유효성 위해 발급받은 프로젝트 키를 사용하여 API Header 에 필수항목들을 설정해야 합니다.
API 연동 방식에 따라, 사용해야 할 프로젝트 키가 달라지므로, API 연동 목적에 맞게 적절한 프로젝트 키를 선택하여 사용해야 합니다. - 프로젝트 키 생성
회원이 요청한 프로젝트에 대해, 관리자가 승인 시, API 연동에 필요한 프로젝트 키가 발급됩니다. - 프로젝트 키 상태
인증키의 상태는 활성화, 비활성화, 폐기 상태로 나눌 수 있다. 비활성화된 프로젝트 키는 활성화 시킬 수 있으나, 폐기된 프로젝트 키는 비활성화 및 활성화 상태로 변경 할 수 없습니다. - 프로젝트 키 타입
API 연동 종류에 따라, 샌드박스 키, UAT 서버 키, SI 키로 나눌 수 있다.
- 샌드박스 키 : KONA PLATE 개발자 사이트에서 제공한 테스트 데이터(입력 및 출력 데이터)로 연동 테스트를 하기 위한 키이다.
- SI(System Integration) 키 : 샌드박스 나 UAT 인증을 위한 목적이 아닌, 시스템 연동을 위해 사용하는 키이다.
- UAT 서버 키 : UAT 인증을 위해 사용되는 키이다. 제휴사가 UAT 인증 요청을 하면, KONA PLATE 관리자를 통해 UAT 인증 키를 부여 받게 된다.
- 액세스 키 : 액세스 키는 시크릿 키를 가리키는 키로써, API Header 의 X-KM-Access-Key에 해당 키를 설정해야 한다.
- 시크릿 키 : 액세스 키와 매핑되는 키로 서, Hmac 생성에 사용되는 키이다. API Header의 X-KM-Tran-Token 에 Hmac 결과 값을 설정해야 한다.