Create an App​

Once you understand the distribution methods for SHOPLINE apps, you can start creating apps according to your specific needs.

Before commencing configuration, you should familiarize yourself with the three distribution methods outlined in this document.

Field Definitions​

Creating a Public App​

STEP 1 Create​

Before you start integration, you need to create a new app in the Developer Center and obtain the APP Key and APP Secret. These two parameters are required for obtaining authorization in the subsequent steps.

After filling in the basic configuration information, you can proceed with the authorization integration. For detailed instructions on configuring a public app, refer to the guide "How to Configure a Public App in the Developer Center".

STEP 2: Implement Authorization​

The app obtains read or write permissions for store data through the OPEN API, and the available APIs depend on the authorization requested during the app installation process. The data content that requires authorization is specified by the app, and the permission points and corresponding interfaces for each permission can be found in the Permission Point List.

During the installation of the app in a store, the platform will prompt the merchant to review the permissions requested by the app. The merchant can assess whether the requested permissions are reasonable. Additionally, if an app requests authorization beyond its actual needs, it may affect the final approval result. The authorization access method is described in the documentation: Authorization Mechanism.

STEP 3: Test Using the Developer Store​

Once the authorization is completed, the app can make API calls to retrieve store data. However, before the official launch, it is necessary to test the app using the development store to ensure that its interaction with the platform matches the expected outcome. For instructions on using the development store, please refer to the documentation: Using the Development Store.

STEP 4: Submit for Review and Approval​

Once the testing is successful, you can proceed with the formal submission for the app to go live. Go to the app details page and locate the submission button. After submitting the app, the platform will complete the review process for the app to go live within 1-2 business days (for payment apps, the verification process may take 3-5 business days).

Before submitting, you can refer to the "App Review Requirements" to ensure that the app meets all the rules and requirements set by the platform.

Creating a custom app​

STEP 1: Create​

You can also create custom apps in the Developer Center.

Unlike custom apps created in the store backend, custom apps created in the Developer Center can be installed in multiple stores of the same merchant without the need for individual configurations for each store.

The configuration method for custom apps can be found in the "Custom App Configuration Guide".

STEP 2: Authorization​

Custom apps created in the Developer Center also use the OAuth 2.0 authorization method.

Before making API calls, the app needs to obtain an Access Token following the authorization mechanism outlined in the "Authorization Mechanism" documentation.

STEP 3: Testing​

Before delivering the app to the merchants, you should use the Developer Store to conduct testing and ensure that the app can correctly interact with the platform's data.

Custom apps do not require approval, but if a merchant provides feedback about quality issues with the app and the two parties cannot reach an agreement, the platform will intervene to assess the situation and proceed with the next steps accordingly.

Creating a private app​

STEP 1: Create​

Unlike the previous two distribution methods, this is a completely merchant-driven app creation approach.

As the app is created by the merchant themselves, there is no need to obtain authorization. Additionally, merchants have real-time control over the API permissions that the app can access.

By accessing the "Apps" module in the Store Management Backend, you can enter the management page for private apps through the Develop Apps entry point. For specific configuration methods, please refer to the Private App Configuration Instructions.

STEP 2: Authorization​

The authorization process for private apps is relatively simple.

You only need to configure the permissions that the app needs to access in the backend and obtain an access token using a merchant or administrator account.

With the access token, you can make regular calls to SHOPLINE's Open API.

STEP 3: Using​

Of course, you can also apply for a developer center account to create a test store for verifying your app. Once everything is ready, you can go back to the actual store and create/install the app there.