권한(스코프)
앱이 요청할 수 있는 권한과 각 권한이 여는 일을 정리했습니다.
업데이트됨 10.13 — 쿠폰 · 회원 적립금 · 상품 배지 API 를 열었습니다규칙
- 모양은
리소스:동작입니다. 예)orders:read - 앱 등록 때 고른 권한이 상한입니다. 그보다 넓게 요청하면 invalid_scope 입니다.
- 판매자가 동의 화면에서 승인한 권한만 토큰에 실립니다. 토큰 응답의 scope 로 확인하세요.
- 쓰기(write) 권한은 동의 화면 · 앱 등록 화면에서 붉게 표시됩니다.
권한 목록
쇼핑몰 관리 권한 — 소유자가 승인
| 스코프 | 이름 | 여는 일 |
|---|---|---|
shop:read | 쇼핑몰 정보 조회 | 쇼핑몰 이름 · 주소 · 판매자(사업자 · 고객센터 · 개인정보 보호책임자) 정보를 읽습니다. |
shop:write | 쇼핑몰 정보 수정 | 쇼핑몰 이름과 판매자 정보를 고칩니다. 손님 화면 하단에 바로 실립니다. |
products:read | 상품 조회 | 상품 목록 · 상세 · 옵션 · 재고를 읽습니다. |
products:write | 상품 등록·수정 | 상품을 만들고 고치고 지웁니다. |
orders:read | 주문 조회 | 주문 목록 · 상세 · 클레임(취소 · 교환 · 환불) 미리보기를 읽습니다. |
orders:write | 주문 처리(발송·취소·환불) | 송장을 넣어 발송하고, 취소 · 환불을 처리합니다. |
customers:read | 회원 조회 | 회원 목록 · 상세와 회원 등급을 읽습니다. 회원 열람은 개인정보 열람 기록에 남습니다. |
customers:write | 회원 수정 | 회원 정보 · 상태 · 등급 · 메모를 고치고, 회원 등급(할인 · 적립 규칙)을 만들고 고치고 지웁니다. |
domain:read | 도메인 조회 | 연결된 도메인과 인증서 상태를 읽습니다. |
domain:write | 도메인 변경 | 도메인을 연결하거나 해제합니다. |
promotions:read | 쿠폰 조회 | 쿠폰 목록 · 상세 · 이용 내역(발급된 쿠폰) · 만든 쿠폰번호를 읽습니다. |
promotions:write | 쿠폰 등록·수정·번호 발급 | 쿠폰을 만들고 고치고 지우고, 다른번호 발급 쿠폰의 번호를 만듭니다. 손님에게 바로 할인이 나갑니다. |
회원 본인 권한 — 회원이 승인
| 스코프 | 이름 | 여는 일 |
|---|---|---|
me:read | 회원 본인 정보 조회 | 동의한 회원 자신의 정보를 읽습니다. |
me:write | 회원 본인 정보 수정 | 동의한 회원 자신의 메일 · 주소 · 수신 동의를 고칩니다. |
두 종류를 섞을 수 없습니다
한 번의 인가 요청에 관리 권한과 회원 권한을 함께 넣으면
invalid_scope 입니다. 관리 권한은 API 주소, 회원 권한은 쇼핑몰 주소의 동의 화면에서 받습니다. → 회원 동의필요한 만큼만
주문을 읽기만 하는 서비스라면
shop:read orders:read 로 충분합니다. 권한을 좁힐수록 판매자의 승인률이 높습니다.