API 권한(Scope) 가이드

  • API로 쇼핑몰의 데이터를 호출하기 위해서는 권한(Scope)에 대한 정의와 동의를 받아야 합니다.
  • 카페24 쇼핑몰에 요청할 수 있는 권한(Scope)의 정의와 사용방법을 자세히 확인할 수 있습니다.

권한(Scope) 역할과 정의

  • API를 이용하여 쇼핑몰의 데이터를 호출할 때에는 반드시 쇼핑몰 운영자에게 API를 이용한 데이터 호출에 대한 권한을 동의받고 취득한 후 API를 호출해야 정상적으로 이용할 수 있습니다.
  • API를 사용하는 App에서 어떠한 권한(Scope)을 사용하겠다는 것을 지정한 후 이를 승인하는 방식으로 권한의 승인이 이루어지며 이는 Access_Token을 발급받는다는 결과와 동일합니다.
  • 카페24에서 제공하는 API는 아래와 같은 권한들을 제공하고 있습니다.
  • 권한구분 형식
권한구분 형식
권한형식 적용범위
mall.read_{{권한값}} 입력한 권한이 보유한 범위의 데이터를 조회할 수 있습니다.
mall.write_{{권한값}} 입력한 권한이 보유한 범위의 데이터를 생성/수정/삭제할 수 있습니다.
  • 권한구분 상세
권한구분 상세
분류 권한구분 적용범위
상품분류
(Categories)
mall.write_category
mall.read_category
mall.read_category,mall.write_category
쓰기권한
읽기권한
읽기+쓰기권한
상품분류(Categories), 메인진열(Mains), 기획전(Projects) 정보
상품
(Product)
mall.write_product
mall.read_product
mall.read_product,mall.write_product
쓰기권한
읽기권한
읽기+쓰기권한
상품(Products) 정보
판매분류
(Collection)
mall.write_collection
mall.read_collection
mall.read_collection,mall.write_collection
쓰기권한
읽기권한
읽기+쓰기권한
브랜드(Brands), 자체분류(CustomCollection), 제조사(Manufacturers), 트렌드(Trends) 정보
공급사
(Supply)
mall.write_supply
mall.read_supply
mall.read_supply,mall.write_supply
쓰기권한
읽기권한
읽기+쓰기권한
공급사(Suppliers), 공급사 운영자(Suppliers/Users) 정보
개인화정보
(Personal)
mall.write_personal
mall.read_personal
mall.read_personal,mall.write_personal
쓰기권한
읽기권한
읽기+쓰기권한
좋아요(Likes), 관심상품(Wishes), 장바구니(Cart) 정보
주문
(Order)
mall.write_order
mall.read_order
mall.read_order,mall.write_order
쓰기권한
읽기권한
읽기+쓰기권한
주문(Orders) 정보
게시판
(Community)
mall.write_community
mall.read_community
mall.read_community,mall.write_community
쓰기권한
읽기권한
읽기+쓰기권한
리뷰톡톡(Reviews), 덧글(Comments) 정보
회원
(Customer)
mall.write_customer
mall.read_customer
mall.read_customer,mall.write_customer
쓰기권한
읽기권한
읽기+쓰기권한
회원(Customers),회원등급(CustomerGroup),적립금(Mileage), 예치금(Deposit), 배송주소록(CustomerAddress) 정보
알림
(Notification)
mall.write_notification
mall.read_notification
mall.read_notification,mall.write_notification
쓰기권한
읽기권한
읽기+쓰기권한
메일(Mail), 메시지(Message) 정보
상점
(Store)
mall.write_store
mall.read_store
mall.read_store,mall.write_store
쓰기권한
읽기권한
읽기+쓰기권한
상점(Store) 정보
프로모션
(Promotion)
mall.write_promotion
mall.read_promotion
mall.read_promotion,mall.write_promotion
쓰기권한
읽기권한
읽기+쓰기권한
고객혜택(Benefits), 쿠폰(Coupons), 시리얼쿠폰(SerialCoupons) 정보
디자인
(Design)
mall.write_design
mall.read_design
mall.read_design,mall.write_design
쓰기권한
읽기권한
읽기+쓰기권한
디자인(Themes), 화면(Pages) 정보

(Application)
mall.write_application
mall.read_application
mall.read_application,mall.write_application
쓰기권한
읽기권한
읽기+쓰기권한
앱(Application) 설치와 관련된 정보
매출통계
(SalesReport)
mall.read_salesreport 읽기권한 매출 통계(SalesReport)와 관련된 정보

권한(Scope) 지정 및 개발 소스코드 반영

  • App에서 권한을 요청하기 전에 반드시 개발자센터에 사용할 권한을 입력해 주어야 App에서 해당 권한을 요청시 정상적으로 인증이 가능합니다.
  • 개발자센터의 [App관리 ▶ App ▶ App 기본정보등록] 화면에서 권한을 입력할 수 있습니다.

  • 위 화면에서 지정된 권한이 App에서 요청하는 권한(Scope)에 동일하게 반영되어야 정상적인 권한 요청이 가능합니다.
  • 권한을 여러개 사용하시는 경우 개발소스에서 콤마(,)로 구분하여 access_token 발급 request를 요청하시면 됩니다.
예시) 여러개의 Scope 사용 예시 (상품분류 - 읽기권한, 상품 - 읽기+쓰기권한, 회원 - 읽기권한, 판매분류 - 읽기+쓰기권한을 요청하시는 경우)

권한(Scope) = mall.read_category, mall.read_product, mall.write_product, mall.read_customer, mall.read_collection, mall.write_collection


샘플 소스코드 < ? php $sMallID = '{몰아이디}'; $sClientID = '{클라이언트 아이디(App key)}'; $sAuthCodeReceiveUrl = 'https://www.aaa.com,https://www.bbb.com,https://www.ccc.com'; $sScope = 'mall.read_category, mall.read_product, mall.write_product, mall.read_customer, mall.read_collection, mall.write_collection'; $aState = array( 'mall_id' => $sMallID, // 고정 '{임의값a}' => '{임의값b}' // 코드발급 이후 처리에 필요한 값 필요시 추가 );

권한(Scope) 추가/수정/삭제시 확인사항

  • App의 개발간 권한에 대한 추가/수정/삭제가 발생하는 경우 반드시 개발자센터에 올바른 권한을 지정해야 하며, 개발소스의 권한(Scope) 변수의 수정이 되어야 합니다.
  • 또한 개발자센터에서 최초 권한을 등록하여 Access_Token을 발급받은 이후에 권한의 변경이 발생한 경우 반드시 쇼핑몰에서 권한사용에 대한 재동의 후 Access_Token을 재발급 받아야 API 호출이 가능합니다.