e
EBUT Developer Portal 이벗 API 통합 문서 · v3 · api.ebut.co.kr
시작하기 · Overview

이벗 API v3 둘러보기

이벗(EBUT) API v3 는 4개의 이커머스 물류 서비스를 단일 게이트웨이 api.ebut.co.kr 으로 통합한 REST 인터페이스입니다. JWT / API Key 이중 인증(페이똑딱은 JWT 전용), 표준화된 응답 구조, 계정 단위 호출량 집계로 셀러 시스템·내부 앱 모두를 안정적으로 지원합니다.

4개 서비스

각 서비스의 OpenAPI 3.1 문서는 포털에서 바로 열람할 수 있습니다. 서비스별 endpoint 수와 사용 사례는 아래 카드를 참고하세요.

게이트웨이 구조

이벗 API 는 모든 요청을 단일 진입점 api.ebut.co.kr 으로 받고 각 서비스 서버로 라우팅합니다. 각 서비스 백엔드 서버에 직접 접근하는 것은 불가능합니다.

외부 클라이언트
     │
     ▼  HTTPS (TLS 1.2 / 1.3)
api.ebut.co.kr  (Nginx 게이트웨이)
     │
     ├── /v3/wms/      → 이벗WMS 서버
     ├── /v3/manager/  → 이벗매니저 서버
     ├── /v3/cam/      → 이벗캠 서버
     ├── /v3/pay/      → 페이똑딱 서버
     └── /v3/mcp/      → 이벗WMS 서버 (MCP 전용)
항목 동작
프로토콜 HTTPS 전용 — TLS 1.2 / TLS 1.3 지원. http:// 요청은 동일 경로의 https:// 로 301 리다이렉트됩니다.
서비스 지정 URL 경로로만 결정됩니다. 서비스를 지정하는 별도 헤더는 없습니다.
속도 제한 출발지 IP 당 초당 30 요청(순간 버스트 50). /v3/mcp/ 는 IP 당 초당 10 요청(버스트 10) — Rate Limits 참고
응답 대기 백엔드 응답을 최대 60초까지 기다립니다. 클라이언트 타임아웃은 그보다 길게 잡아주세요.
정의되지 않은 경로 표준 응답 봉투로 NOT_FOUND (HTTP 404) 를 반환합니다. 게이트웨이의 에러 응답도 각 서비스와 동일한 형식입니다.
왜 게이트웨이만 허용하나요? 인증·Rate Limit·로깅·트래픽 안정성을 게이트웨이에서 일괄 처리하기 때문입니다. 이를 통해 백엔드 변경(서버 이전·인프라 교체)이 외부 클라이언트에 영향을 주지 않습니다.

인증 방식

요청 형태에 따라 두 가지 인증 방식 중 하나를 사용합니다. 자세한 헤더 형식·발급 방법은 인증 가이드 를 참고하세요.

방식 헤더 대상
API Key X-API-Key: ebut_wms_live_... 외부 셀러 시스템 / 자동화 스크립트
JWT Authorization: Bearer {token} 이벗 내부 웹 / 앱 · 페이똑딱 전체
⚠️ 페이똑딱(/v3/pay/)은 API Key 를 지원하지 않습니다 JWT 전용이며 X-API-Key 로만 호출하면 403 AUTH_FORBIDDEN 이 반환됩니다. 이벗WMS · 매니저의 AI 분석 endpoint 도 JWT 전용입니다 — 서비스별 지원 인증은 인증 가이드 를 확인해 주세요.

표준 응답 구조

모든 endpoint 는 일관된 JSON 응답을 반환합니다. success 플래그로 성공 여부를 먼저 판단한 뒤 data 또는 error 를 처리하세요.

성공 (단건)

HTTP 200
{
  "success": true,
  "data": { ... }
}

성공 (목록)

HTTP 200
{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "size": 20,
    "total": 150,
    "total_pages": 8,
    "has_next": true
  }
}

실패

HTTP 400 | 401 | 403 | 404 | 409 | 429 | 500
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "에러 메시지"
  }
}

필드 규칙

항목 형식 예시
필드명snake_casemall_product_name
날짜 (varchar)yyyyMMdd20260614
날짜시간 (datetime)yyyy-MM-dd HH:mm:ss2026-06-14 11:17:23
금액 / 수량integer100000
booleantrue / falseY/N 사용 안함
코드값integer문자열 사용 안함
v2 와의 차이 v2 API 는 일부 필드가 camelCase · 일부 코드값이 문자열이었습니다. v3 부터는 모든 필드가 snake_case + 직관적 명칭, 코드값은 integer 로 통일됩니다.

다음 단계

준비가 되셨다면 Quickstart 에서 첫 호출을 5분 안에 완료하실 수 있습니다. API Key / JWT 토큰이 필요하시면 help@ebut.co.kr 로 신청해 주세요.