Creating Private Apps with SHOPLINE Develop Apps – SHOPLINE Help Center

Develop Apps is an application framework created specifically for your SHOPLINE store, either by you or by an external developer. Unlike public apps designed for multiple stores, Develop Apps are private and tailored to the unique needs of your store.

With Develop Apps, you can securely access your store data through the SHOPLINE Admin API or extend your storefront capabilities to external platforms using the Storefront API. Each app comes with its own API Key and App Secret, which identify your app, as well as API access tokens that authorize API requests based on the permissions you configure.

By generating and managing these API credentials, you can integrate SHOPLINE data into your internal systems, automate workflows, or build custom features that support your business operations. If you plan to develop a custom app—either independently or with the help of developers—to meet growing business requirements, Develop Apps provides the flexibility and control needed to do so securely.

Configuring App Management Permissions

Before creating a private app, make sure you have the Private App Management permission. Store managers automatically have full app development access.

As a store manager, you can grant your staff app development permissions, such as viewing or editing private apps.

To set staff permissions:

Log in to the SHOPLINE Admin, go to Settings, and click Staff and permissions.
Locate the staff member you want to assign the permission to, and click the pencil icon in the Actions column.
Under Permission management, check Manage private apps and click Update to save.

Creating an App

1- create app step.png

Read and check on the box if you agree with the 《API permissions and terms》 of use click on Enable development.

2- terms and use agreement.png

Click on Create an App and input App name, App’s developer, and App’s contact email address, and then click Create an App.

3-create app.png

Configuring Admin API Permissions

Click on Edit > Permission configuration tab > Configuration button of Integrate Admin API option.

4- Admin API config..png

Enter Access range of Admin API page and set access range, create a Webhook, and press Save.

5-admin API setting pg.png

Configuring Storefront API Access Permissions

Click Edit to enter the application details page, select the Permission configuration tab, and click Configuration for Integrate store API.

6-store API setting.png

Enter the store API permission editing page, check the option for setting API access permissions, and click Save.

Accessing API Keys and Generating API Tokens

To access your API credentials, go to the API certificate tab. This page displays your API certificates and the access tokens generated based on your permission configuration.

API Certificates

Under the API certificate tab, you will find two essential credentials in the API certificate section:

API Key: The unique identifier for your app.
App Secret: The private key used to securely sign API requests.

These values are created automatically when the app is generated. The App Secret is masked for security and can be copied when needed.

Generating API Access Tokens

After configuring the Admin API and/or Storefront API permissions, go to API certificate > Access token and click Install App to generate the API access tokens.

Admin API Access Token
- Requires authentication to view or refresh.
- Valid for 3 years once generated.
- Allows access to admin-level API endpoints.
Store API Access Token
- Can be copied directly without additional authentication.
- Used for store-level API interactions.

These tokens allow secure communication with SHOPLINE services and must be kept confidential. If the app is uninstalled or reinstalled, previously issued tokens may become invalid and must be regenerated.

App Settings

In the App Setting tab, you can change the app's name, developer info, and description.

You can also turn a private app into a Sales Channel. After conversion, the private app can use sales channel features, such as using the Storefront API to get product information. For more details, please refer to the developer documentation.

Note:

Once a private app is changed to a sales channel, it cannot be changed back.
You do not need SHOPLINE approval to convert a private app to a sales channel.
When a private app converts into a sales channel, Channelhandle is its Appkey
Products will not be published to the new sales channel by default. You need to manually set products to be available on that channel.

9- App setting.png

Viewing Operation Log

Switch to Operation log to view all operation events.

10-Operation log.png

Uninstalling App

Click Uninstall App. After uninstallation, the API access token will be revoked, and the application will no longer have permission to access store data through the Open API.

11- uninstall.png

Deleting a Develop App

Return to the Develop Apps main page, click Delete to delete the selected app. Application data will be cleared, and the API access token will be revoked. The application will no longer have permission to access store data through the Open API.