API権限(Scope)ガイド

  • APIでショップのデータを呼び出しするためには権限(Scope)について定義と同意が必要です。
  • cafe24のショップに申込できる権限(Scope)の定義と使用方法の詳細について確認いただけます。

権限(Scope)の役割と定義

  • APIを利用してショップのデータを呼び出しする時には、必ずショップ運営者からAPIを利用したデータの呼び出しについて権限を取得した後からAPIを正常に利用できます。
  • APIを使用するAppで、いずれかの権限(Scope)を使用することを指定してから承認する方式で権限を付与。つまりAccess_Tokenを発行する結果と同一です。
  • cafe24 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
書き込み
閲覧
閲覧+書き込み
Review de Talk(Reviews)、コメント(Comments)情報
会員
(Customer)
mall.write_customer
mall.read_customer
mall.read_customer,mall.write_customer
書き込み
閲覧
閲覧+書き込み
会員(Customers)、会員ランク(Customer Group)、ポイント(Mileage)、預り金(Deposit)、お届け先一覧(Customer Address)情報
通知
(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)、クローズドクーポン(Serial Coupons)情報
デザイン
(Design)
mall.write_design
mall.read_design
mall.read_design,mall.write_design
書き込み
閲覧
閲覧+書き込み
デザイン(Themes)、画面(Pages)情報
App
(Application)
mall.write_application
mall.read_application
mall.read_application,mall.write_application
書き込み
閲覧
閲覧+書き込み
App(Application)インストールに関連した情報
売上統計
(SalesReport)
mall.read_salesreport 閲覧 売上統計(SalesReport)に関連した情報

権限(Scope)指定および開発ソースコードの反映

  • Appから権限を申込む前に、必ずcafe24 デベロッパーにて使用する権限を設定してください。Appから権限を申込時、正常に認証が可能です。
  • cafe24 デベロッパーの[App管理 ▶ App ▶ App 基本情報登録]画面から権限を設定できます。

  • 上記画面の指定された権限をAppから申込する権限(Scope)に同一に反映されると正常に権限申込が可能です。
  • 権限を複数使用する場合は、ソースコードにカンマ(、)区切りでaccess_token取得requestを申込ください。
例)複数のScope使用例 (商品カテゴリ - 閲覧権限、商品 - 閲覧+書き込み権限、会員 - 閲覧権限)

権限(Scope) = mall.read_category, mall.read_product, mall.write_product, mall.read_customer


サンプルソースコード < ? php $sMallID = '{ショップID}'; $sClientID = '{クライアントID(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'; $aState = array( 'mall_id' => $sMallID, // 固定 '{任意値a}' => '{任意値b}' // コード発行後の処理に必要な値、必要な場合に追加 );

権限(Scope)追加/修正/削除時の確認事項

  • Appの権限について追加/修正/削除が発生する場合、必ずcafe24 デベロッパーに正しい権限を指定し、開発ソースの権限(Scope)変数を修正する必要があります。
  • また、cafe24 デベロッパーから最初権限を登録し、Access_Tokenの取得した以降に権限の変更が発生した場合は、必ずショップの権限使用について再同意の後、Access_Tokenを再取得してからAPIの呼び出しができます。