BigCommerce Apps Quick Start Tutorial

Get started

You’ll need a Developer Portal account to register the draft app and a BigCommerce store to test the installation. If you don’t already have both, get them now:

Fork the sandbox

Once you have a Developer Portal account and a store, fork our express-hello-world-app. To do so:

Open the Express Hello World App in CodeSandbox.
Click Fork in the top right.

Register a draft app

Next, register a draft app in the Developer Portal using the sandbox’s app URL. To do so:

Login to the Developer Portal
Click Create an App
Give the app a name
Click Technical
Enter Auth Callback URL. Ex: https://{{YOUR_FORK}}.sse.codesandbox.io/auth
Enter Load Callback URL. Ex: https://{{YOUR_FORK}}.sse.codesandbox.io/load
Enter Uninstall Callback URL. Ex: https://{{YOUR_FORK}}.sse.codesandbox.io/uninstall
Click Update & Close
Click View Client ID – this is the app’s client_id and client_secret

Keep this tab open for the next step.

Configure sandbox environment

After registering the app, enter the app’s credential’s and auth callback into your sandbox’s environment variables (codesandbox.io):

callback => https://{{YOUR_FORK}}.sse.codesandbox.io/auth
client_id => the app’s client ID from the Developer Portal
client_secret => the app’s client secret from the Developer Portal

Install the app

Log in to your store and navigate to Apps > My Apps > My Draft Apps and install the app.
If everything is configured correctly, you should get an Authorization Successful message.
Navigate back to My Apps to see the list of installed apps.
Click Launch on the draft app to test the /load callback.
Navigate back to My Apps and click Uninstall to test the /uninstall callback.

Congrats! You’ve created and installed your first BigCommerce app.

Next steps

Apply to become a BigCommerce partner (required to publish apps to marketplace)
Learn more about Building Apps
Check out the App Marketplace