Managing Apps in the Developer Portal

Create, edit, and submit apps for approval using the Developer Portal. In Beginning App Development, we briefly touched on how to create a draft app. In this article, we’ll go over how to perform other common app management tasks. To get started, sign in or create an account in the Developer Portal.

Create an app profile

Creating an app also creates an app API account. To learn more about app API accounts, see the Guide to API Accounts. To create an app, do the following:

1. Sign in or create an account with the Developer Portal.

2. Click the Create app button on the right side of the landing page.

3. Give your app a name in the Set up your app dialog. This name is only visible to you. Once complete, click the Generate Credentials button.

4. The app created dialog appears, displaying your app’s Client ID and Client Secret. Click the Finish button to redirect the page to the app editor.

5. Click the Scopes tab at the top.

6. Toggle the necessary OAuth scopes for your app.

7. Click the Save changes button on the registration dialog’s lower right corner.

8. A new dialog opens, asking if you want to add new OAuth scopes. Click Confirm new scopes.

You can view the client ID and client secret any time; see the following section on viewing credentials.

View credentials

1. To view an app API account’s credentials, navigate to the Dev Portal’s Apps overview and click the View credentials icon to the right of the relevant app’s listing.

2. A dialog box opens to reveal your API account credentials.

To learn more about using an app API account to generate store-specific access tokens, see Implementing the OAuth Flow.

Edit an app profile

1. To edit an app, navigate to the Dev Portal’s Apps overview and click the name of the app you want to edit.

2. The app editor opens.

Edit technical details

1. Once you enter the app editor, click the App information tab at the top to edit enabled features and callback URLs.

2. To edit OAuth scopes, click the Scopes tab at the top.

3. To save your change, click the Save changes button on the editor’s lower right corner.

4. A new dialog opens, asking if you want to add new OAuth scopes. Click Confirm new Scopes.

5. After saving, edits are effective immediately for all app users.

Indicate multi-storefront support

If your app supports stores that sell through multiple storefronts or sales channels, add that information to the app’s profile.

1. Once you enter the app editor, click the Listing information tab at the top.

2. Select either Single Storefront or Multi Storefront. This doesn’t grant or deny your app access to any APIs; it helps us test and label your app appropriately.

3. To save your change, click the Save changes button on the edit dialog’s lower right corner.

To read about designing or modifying your app to support multi-storefront, see Multi-Storefront App Compatibility and Optimization

Submit an app for approval

1. Submit apps for App Marketplace approval by navigating to the Dev Portal’s Apps overview, then finding the app you want approved and clicking the Publish app… option from the action menu to the right of its listing.

2. The Confirm listing information page opens; verify the information provided, and click the Submit app for review button in the bottom right corner.

To learn more about completing app registration fields and submitting apps for approval, consult our App Publishing Guide.

Deleting apps

Deleting an app also deletes its API account. This is a destructive action; you can’t recover the app or its API account. Do not delete an app without serious consideration, particularly if it is in production. It is likely to have far-reaching negative impacts on your users’ stores.

To learn about mitigating the risks of deleting an app and its API account, see the Guide to API Accounts.

1. To delete an app, navigate to the Dev Portal’s Apps overview and click the Delete app option from the action menu to the right of its listing.

2. The delete app dialog opens to verify whether you truly want to delete the app. Click Delete.

Next steps

• Implement the OAuth flow
• Handle app callbacks

Resources

Related articles

• Introduction to Building Apps
• Beginning App Development
• Implementing App OAuth
• App Approval Requirements
• Publishing an App
• Guide to API Accounts

Other resources

• Developer Portal (devtools.bigcommerce.com)
• Partner Portal (partners.bigcommerce.com)
• Technology Partner Program (partners.bigcommerce.com)
• BigCommerce App Marketplace (bigcommerce.com)