Getting Started #
1. 소개 #
통합빌링시스템은 고객의 구매 처리, PG와의 결제 및 정산/통계에 대한 기능을 제공하는 시스템입니다.
통합빌링시스템에서 제공하는 API의 프로토콜은 디바이스의 종류와 관계없이 유연하게 구현할 수 있는 방법(RESTful API)으로 제공되며, 모든 통신은 서버-클라이언트 기반으로 동작합니다.
기본적으로 빌링시스템의 API를 사용하는 클라이언트(CP, Store, …)가 전송한 메시지에 대해 통합빌링시스템이 결과 데이터를 포함하는 응답을 보내는 것으로 구성됩니다.
2. 기본 정보 #
EBP REST API는 HTTP 프로토콜을 기반으로 하며, 다음과 같은 특징을 가집니다.
- Data Format: JSON (Content-Type:
application/json; charset=utf-8) - Character Set: UTF-8
- API Base Path:
/api/v2
환경별 서버 정보 (Domain/Host) #
| Environment | Region | Domain (Host) |
|---|---|---|
| DEV | KIC | devkic-payapi-int.nebp.lge.com |
| AIC | devaic-payapi-int.nebp.lge.com | |
| EIC | deveic-payapi-int.nebp.lge.com | |
| QA | KIC | qakic-payapi-int.nebp.lge.com |
| AIC | qaaic-payapi-int.nebp.lge.com | |
| EIC | qaeic-payapi-int.nebp.lge.com | |
| PRD | KIC | kic-payapi-int.nebp.lge.com |
| AIC | aic-payapi-int.nebp.lge.com | |
| EIC | eic-payapi-int.nebp.lge.com |
3. 인증 및 공통 헤더 #
모든 API 호출 시에는 인증 및 무결성 검증을 위해 다음의 헤더를 반드시 포함해야 합니다.
| Header Name | Description | Required |
|---|---|---|
X-Access-Key | EBP 시스템 접근을 위한 인증 키 | Yes |
X-EBP-Signature | 요청 무결성 검증을 위한 시그니처 (Payload + Hash Key) | Yes |
X-Division-Code | 사업부 코드 | Yes |
X-Store-Id | 스토어 ID | Yes |
X-Channel-Code | 채널 코드 | Yes |
X-Ric-Code | 권역 구분 코드 (예: KIC, AIC, EIC) | Yes |
X-Country-Code | ISO 국가 코드 | Yes |
상세한 헤더 정보는 Common Headers 문서를 참고하세요.
4. 공통 응답 구조 #
API 호출에 대한 응답은 성공 여부와 관계없이 일관된 구조를 반환합니다.
4.1. 공통 응답 필드 명세 #
| depth | Field | Details & Description |
|---|---|---|
| -1 | resultCode |
🔴 Required 결과 코드 (성공 "0", 에러 시 "EBP-A-0001" 등) |
| -1 | message |
🔴 Required 결과 메시지 (성공 또는 에러 상세) |
| -1 | requestId |
🔴 Required 추적을 위한 고유 요청 ID |
| -1 | timestamp |
🔴 Required ISO 8601 형식의 응답 타임스탬프 e.g., 2025-12-19T14:24:00+09:00 |
4.2. 필드 속성 아이콘 가이드 #
| 아이콘 (Icon) | 설명 (Description) |
|---|---|
| 문자열 (String) 타입 | |
| 숫자 (Number) 타입 | |
| 불리언 (Boolean) 타입 | |
| 객체 (Object) 타입 | |
| 배열 (Array) 타입 | |
🔴 Required | 필수 (Required) 필드 |
⚪ Optional | 선택 (Optional) 필드 |
🟡 Conditional | 조건부 (Conditional) 필드 |
JSON
{
"resultCode": "0",
"message": "SUCCESS",
"requestId": "1767079168322",
"timestamp": "2025-12-30T07:19:28.323457100Z",
"data": { ... }
}
5. 주요 API 그룹 #
- Billing Account API: 토큰(Token) 등록/조회/삭제 및 PIN 관리
- Purchase API: 결제 준비, 토큰 결제, 결제 취소, 영수증 조회 등 구매 관련 프로세스
- Settlement API: 셀러 정보 관리 및 정산/결제 내역 조회
6. 결제 흐름 (Flow) #
결제 상태 흐름도 및 상세 프로세스는 다음 문서를 참고하세요.