App basic settings

  • This is a guide to register the app and perform basic management using cafe24 developer center.

App setup

  • When you sign in to the developer center, you'll see an administration screen where you can create and manage your app.
  • [1]: A new app may be created.
  • [2]: The registered app is shown and the basic status of the app can be checked.

1. New registration of App

  • [1]: App name
    Enter the name of your app. This name is used for internal management and not as the name for sale on the App Store.
  • [2] : App URL
    Enter the basic service URL on which your app can be serviced and promoted.
    The service of apps requires you to enter the SSL authentication URL in the form of https:// for flawless service.
    If you need to specify a port to be serviced, you can enter it together.
  • [3]: App Type
    You can choose the type of app to be created and serviced.
    The type of app selected is used as a reference for API key issuance and cannot be changed later.
    Generally, you can select the web application unless the app is native.

2. Display and status of registered App

  • [1]: The date the app was created is displayed.
  • [2]: The representative icon of the app is displayed.
    A blank image is displayed with no icon registered.
  • [3]: App name is displayed.
    The name of your app displayed is for management, not for use on the App Store.
  • [4]: App status is displayed.
    The status of an app can be displayed as "in production," "under review," "review rejected," "for sale" and "sold."
    Should the app be rejected during the review process, an additional image of [5] will be shown.
    When the app has a "for sale" status, you are not allowed to arbitrarily delete the app, which can be processed and deleted upon inquiry at cafe24.
  • [5]: Reason for review rejection is displayed.
    When an app is rejected upon review, you can see the reason for the rejection by clicking on the icon.

Management of the App's basic setting

  • Clicking on the app created in the developer center exposes a screen where you can register and manage the basic information of the app.

1. Basic information

  • [1]: App name can be modified.
    The app‘s initial name chosen during its creation is shown by default. You can modify the app’s name if necessary.
    The name listed here is for management purposes. It is not the name shown on the App Store.
     
  • [2]: App URL can be modified.
    The App URL entered during its creation is shown by default. You can modify the App URL if necessary.
    Please be careful when modifying the URL of the app for sale or in service because the modification may cause a hindrance in service.
     
  • [3]: Redirect URL(s) can be entered or modified.
    After an app is authenticated, you can enter the URL to be transmitted to redirect_uri.
    Separation of the URL can be input using the Enter key (Up to 10 URLs / Within 200 bytes).
    https must be used as a security policy (http is not supported).
    If you have a sub-domain, please only enter the representative domain name (e.g. https://cafe24.com).
     
  • [4]: Representative icon of the app
    You can register representative icons to easily distinguish apps on the App Store or the shopping mall platform.
    Representative icons for apps help users identify and promote their apps.
    Recommended (registered) image: 120px * 120px / no larger than 50KB / png, jpg (jpeg)

2. Permission Information

  • [1]: API permissions can be added or removed.
    You can add or remove permissions for the APIs to be utilized by the apps. In order to use the API, the permission for use must be registered.
    When you select the permission, you will be asked for consent when installing an app on the shopping mall, whereas the API will be properly called as agreed.
    When calling for an unauthorized API, a 404 error (permission unauthorized) will occur and no API results will be obtained.
     
  • The classification and scope of application of permission are as follows:
Scope classification detail
Category Application Scope
Categories Information on categories, main displays and projects
Product Product information
Collection Information on brands, custom collection, manufacturers and trends
Supply Information on suppliers and suppliers/users
Personal Information on likes, wishes, and cart
Order Order information
Community Information on reviews and comments
Customer Customer, customer group and mileage
Notification Information on mail and message
Store Store information
Promotion Information on benefits, coupons, and serial coupons
Design Information on themes and pages
Application Information on application installation
SalesReport Information pertaining to the sales report
  • For detailed methods for security / authentication and API call using authorization, please refer to the Authentication/Security Guide, API Guide or API Support Tool Guide.

  • [2]: When you need to set up the rights of the sub-operators and suppliers of the shopping mall when executing the app, you can enter or modify the URL where the screen list and action permission list of the app can be confirmed.
    If you need to check and control the granted permission of the shopping mall operator within an app, please refer to the Operator Authority Development Guide.

3. Authentication Information

  • [1]: App type can be confirmed.
    The app type you selected during its creation is displayed. App types cannot be modified because they are relevant to API key authentication.
     
  • [2]: App Key can be confirmed and copied.
    This is one of the two basic key values required to use the API. App key is typically the same value as Client ID in OAuth's criteria, and is the equivalent of ID in a shopping mall's login criteria.
     
  • [3]: You can confirm, copy and reissue App Secret Keys.
    This is one of the two basic key values required to use the API. App Secret Key is typically the same value as the Client Secret at OAuth's criteria and the equivalent of a password.
    In addition to the app key, if the app secret key is leaked or exposed, the app's security can become very weak.
    If any suspicious circumstances are found, it is recommended that the App Secret key be reissued and renewed.
    However, if you receive a re-issuance of the app password, you must obtain permission to use the app again for normal use. You must get it reissued when you think it is necessary.
    Please be careful when the app password is reissued due to reasons not necessary during the service, as the service may be interrupted or the app may not operate properly.