API scope guide

  • In order to call the shopping mall data with the API, you must have the scope defined and approved.
  • You can find out more about the definition and usage of the requestable scope for the cafe24 shopping mall.

Role and definition of scope

  • When using the API to call the shopping mall data, you must get permission from the shopping mall operator for the data call using the API before making the call for proper execution.
  • The scope is approved when the scope to be used shall be specified for the app using the API for approval, which in turn is the same as having an Access Token issued.
  • The API provided by cafe24 provides the following scopes.
  • Scope classification
Scope classification
Scope type Application Scope
mall.read_{{scope value}} The data of the scope belonging to the entered scope can be viewed.
mall.write_{{scope value}} The data of the scope belonging to the entered scope can be created / updated / deleted.
  • Scope classification detail
Scope classification detail
Category Scope classification Application Scope
Categories mall.write_category
mall.read_category
mall.read_category,mall.write_category
Write
Read
Read+Write
Categories, Mains, Projects
Product mall.write_product
mall.read_product
mall.read_product,mall.write_product
Write
Read
Read+Write
Product
Collection mall.write_collection
mall.read_collection
mall.read_collection,mall.write_collection
Write
Read
Read+Write
Brands, Custom Collection, Manufacturers, Trends
Supply mall.write_supply
mall.read_supply
mall.read_supply,mall.write_supply
Write
Read
Read+Write
Suppliers, Suppliers/Users
Personal mall.write_personal
mall.read_personal
mall.read_personal,mall.write_personal
Write
Read
Read+Write
Likes, Wishes, Cart
Order mall.write_order
mall.read_order
mall.read_order,mall.write_order
Write
Read
Read+Write
Order
Community mall.write_community
mall.read_community
mall.read_community,mall.write_community
Write
Read
Read+Write
Reviews, Comments
Customer mall.write_customer
mall.read_customer
mall.read_customer,mall.write_customer
Write
Read
Read+Write
Customers, Customer Group, Mileage, Deposit, Customer Address
Notification mall.write_notification
mall.read_notification
mall.read_notification,mall.write_notification
Write
Read
Read+Write
Mail, Message
Store mall.write_store
mall.read_store
mall.read_store,mall.write_store
Write
Read
Read+Write
Store
Promotion mall.write_promotion
mall.read_promotion
mall.read_promotion,mall.write_promotion
Write
Read
Read+Write
Benefits, Coupons, Serial Coupons
Design mall.write_design
mall.read_design
mall.read_design,mall.write_design
Write
Read
Read+Write
Themes, Pages
Application mall.write_application
mall.read_application
mall.read_application,mall.write_application
Write
Read
Read+Write
Application installation
SalesReport mall.read_salesreport Read About Sales Report

Scope setting and sample development source code

  • The scope to be used must be entered at the Developer Center prior to making a request from the app so that the app requests the scope for proper authentication.
  • Scopes can be entered in the [App Management ▶ App ▶ Permissions information] screen in the Developer Center.

  • The scope specified in the above screen must be reflected as the same as the scope requested by the app for a proper scope request.
  • When using a number of scopes, separate them in the development source using commas as you request an issuance of the Access Token.
Example) Example of multiple scopes
(product classification - read scope, product - read + write scope, customer - read scope, sales classification - when requesting read + write scope)

Scope = mall.read_category, mall.read_product, mall.write_product, mall.read_customer, mall.read_collection, mall.write_collection


Sample source code < ? php $sMallID = '{Mall ID}'; $sClientID = '{Client 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, mall.read_collection, mall.write_collection'; $aState = array( 'mall_id' => $sMallID, // Fixed '{Random value}' => '{Random value}' // Values ​​required for processing after code issuance - add as needed );

Checklist when adding / modifying / deleting scope

  • In the event of addition / update / deletion of scope in the course of app development, you must assign the correct scopes in the Developer Center and update the scope variables of the development source.
  • In addition, if any changes in scopes occur after registering the first scope in the Developer Center for issuing an Access Token, you must have the Access Token reissued after re-agreeing with the usage of the changed scopes at the shopping mall for a proper API call.