Creating a Custom App​

Custom apps are typically used for creating custom apps for individual merchants. To distribute these using the "single merchant install link" method, you can create a custom app in the developer center. Custom apps do not need to be listed on the app marketplace, and they do not require platform review.

Prerequisites​

• Distribution methods for SHOPLINE apps
• App creation process

STEP 1: Create an App​

1. Go to the "Apps" module in the Developer Center and click the "Create App" button.

2. Select "Custom App" and fill in the basic information.

• App Name: This name will be displayed to merchants, unlike in public apps.
• App URL: The running address of the app. When merchants access the app on the platform, SHOPLINE will redirect to this address.
• App Callback URL: Used to receive platform callbacks, such as when requesting authorization. SHOPLINE will callback to this address with parameters.
  • If you need to receive callbacks in different app environments for testing purposes, you can configure multiple callback addresses.
  • When configuring multiple callback addresses, specify the callback address to receive in the request parameters.

STEP 2: Complete Basic Configuration​

1. Click on the created app to enter the app configuration panel and select "App Settings".

2. App Open Method:

• Embedded: The app is loaded using an iframe within the SHOPLINE admin panel. Merchants do not need to leave the SHOPLINE admin panel, providing a better user experience. To use the embedded method, you need to integrate the App Bridge capability provided by the platform.
• External: The app runs in a new browser tab.

3. App Contact: SHOPLINE will use this contact information to communicate with you regarding important updates. Please ensure that the contact information is accurate and valid.

STEP 3: Configure the Available Store List​

1. Click on "Merchant Use " to enter the merchant list configuration page.

2. Set the basic information for the app.

• App Description: Briefly describe the purpose of the app for easier merchant management.
• App Logo: The icon displayed in the app marketplace. It should meet the specifications of 120x120 pixels.

3. Merchant Store Handle:

• Custom apps are created for individual merchants and can be installed by multiple stores belonging to the same merchant. However, they cannot be installed by multiple merchants. Therefore, the handle you enter here must come from the same merchant.

STEP 4: Subscribe to Webhook Events​

Subscribing to events is not mandatory, but utilizing subscribed events can help keep your app data synchronized with SHOPLINE. After specific events occur in a store, the platform triggers a webhook notification and sends the message to the installed apps that have subscribed to that event. You can manage your subscriptions in the developer center:

STEP 5: Generate Authorization URL for Merchants​

1. Concatenate the authorization URL in the following format.
2. Provide the URL to the stores that are already configured in the available list.
3. After logging in to the store, the merchant can paste and run the authorization URL in the browser to complete the installation.

https://{handle}.myshopline.com/admin/oauth-web/#/oauth/authorize?appKey=******&responseType=code&scope=*******&redirectUri=*******

Link Explanation:

• handle: The unique identifier of the store.
• appKey: Generated during app creation, which can be found on the app management page.
• responseType: The response type, with a fixed value of "code."
• scope: The permission points that require store authorization. If multiple permission points are needed, separate them with a comma (","). The association between interfaces and permissions can be found in the Scope and Permissions List.
• redirectUri: The redirect address after authorization, which can be any page within the app.

Next Steps​

• Testing apps in the development store
• Set up website navigation to make your app easier to use