REST API 개요

페이리 공개 REST API는 내 서버에서 주문·상품·구독·라이선스를 다루기 위한 엔드포인트예요.
모든 요청은 HTTPS이며, 상태를 서버에 저장하지 않는(stateless) X-Api-Key 인증을 써요.
경로는 /v1으로 버저닝돼요.

Base URL

https://api.payri.kr/v1

이 문서의 경로 표는 위 베이스 이후의 path만 적어요.

인증

모든 요청 헤더에 API 키 평문을 담아요.

curl https://api.payri.kr/v1/orders \
  -H "X-Api-Key: pk_live_xxxxxxxxxxxxxxxxxxxxxxxx"

자세한 규칙은 인증에서 다뤄요.

식별자 접두어

응답에 담긴 ID는 접두어로 종류를 구분해요.

페이지네이션

목록 엔드포인트는 공통 쿼리 파라미터를 받아요.

정렬은 최신순 고정이에요.
주문·상품은 생성 시각, 구독은 시작 시각의 내림차순으로 와요.

응답은 다음 형식으로 와요.

{
  "data": [ /* 리소스 배열 */ ],
  "total": 128,
  "page": 1,
  "limit": 20
}

에러

에러 응답은 공통 형태예요.

{
  "statusCode": 403,
  "code": "FORBIDDEN",
  "message": "필요한 권한이 없습니다: refunds:write"
}

코드별 의미는 에러 코드에서 다뤄요.

레이트 리밋

기본 한도는 60초당 120요청이고, 요청 IP 기준으로 계산돼요.
초과하면 429 RATE_LIMITED로 응답해요.

엔드포인트 한눈에 보기