스코프
파트너 앱이 요청할 수 있는 OAuth 스코프 값과 고객에게 보이는 이름, 스코프마다 호출할 수 있는 v2 API를 정리했어요.
스코프는 인가 요청의 scope에 공백으로 구분해 넣어요. 고객의 연결 화면과 연결된 앱 화면에는 고객에게 보이는 이름으로 나와요.
| 스코프 | 고객에게 보이는 이름 | 호출할 수 있는 API |
|---|---|---|
invoices:read |
주문 조회 | 주문 목록 조회, 주문 단건 조회 |
invoices:write |
주문 등록·수정·취소 | 주문 생성, 주문 수정, 주문 취소 |
invoices:mark_paid |
주문 입금 확인 처리 | 주문 결제 완료 처리 |
transactions:read |
입금 내역 조회 | 입금 내역 목록 조회, 입금 단건 조회 |
cash_receipts:read |
현금영수증 조회 | 현금영수증 목록 조회, 현금영수증 단건 조회, 현금영수증 문서 주소 조회 |
cash_receipts:issue |
현금영수증 발행·재발행·취소 | 현금영수증 발급, 현금영수증 재발급, 현금영수증 취소, 현금영수증 이메일 전송 |
스코프는 서로 포함하지 않아요. 예를 들어 invoices:write만 받은 토큰으로는 주문을 만들 수 있지만 주문 목록은 조회할 수 없어요. 필요한 스코프를 모두 요청하세요.
스코프 정하기
- 앱은 페이싱크에 등록한 스코프 안에서만 요청할 수 있어요. 등록하지 않은 스코프를 요청하면 연결 화면에 오류가 나와요.
- 앱이 실제로 쓰는 스코프만 요청하세요. 고객은 연결 화면에서 요청한 스코프를 모두 보고 허용해요.
- 페이싱크가 앱에 등록된 스코프를 줄이면, 이미 발급한 토큰에서도 그 스코프가 바로 빠져요. 고객의 연결된 앱 화면에서도 그 권한이 사라져요.
토큰에 없는 스코프가 필요한 API를 호출하면 403, 380010이 와요. 스코프를 늘리려면 고객에게 새 scope로 다시 인가 요청을 보내요.
계좌, 웹훅, 멤버, 구독 같은 워크스페이스 설정 API는 어떤 스코프로도 호출할 수 없어요.