Skip to Content

인증

페이리 REST API는 X-Api-Key 헤더로 인증해요.
헤더에 API 키 평문을 그대로 담아 보내면 돼요.
키 모드(live/test)는 운영·개발 환경을 구분하는 표시예요.

요청 헤더

curl https://api.payri.kr/v1/orders \ -H "X-Api-Key: pk_live_xxxxxxxxxxxxxxxxxxxxxxxx"
헤더
X-Api-KeyAPI 키 평문 (pk_live_… / pk_test_…)

Authorization: Bearer …가 아니라 X-Api-Key예요.
secret 키는 서버→서버 비밀 값이니 브라우저·앱 같은 클라이언트에 노출하지 마세요.
브라우저에서 직접 호출해야 한다면 결제 세션 생성만 가능한 browser 키를 쓰세요.

검증 순서

서버는 받은 키를 다음 순서로 검사해요.
하나라도 실패하면 해당 에러로 응답해요.

  1. 키 조회 — 등록된 키인지 확인해요. 없으면 401 TOKEN_INVALID.
  2. IP 검사 — 허용 IP 목록이 있으면 출처 IP를 대조해요. 벗어나면 403 FORBIDDEN.
  3. 스코프 검사 — 엔드포인트가 요구하는 스코프를 키가 모두 가졌는지 봐요. 부족하면 403 FORBIDDEN.

검증을 통과하면 키가 묶인 스토어·상품 범위 안에서만 요청이 처리돼요.

인증 실패 예시

{ "statusCode": 401, "code": "TOKEN_INVALID", "message": "유효하지 않은 API 키입니다." }

다음 단계

스코프

엔드포인트별 요구 스코프예요.

에러 코드

401·403·404를 구분해요.

Last updated on