Dev Tools is the BigCommerce workspace for developing single-click apps. Within Dev Tools, you’ll create the Client Id and Client Secret to authenticate your apps, submit new apps to the App Marketplace, and manage existing Marketplace listings.
Dev Tools can be found by clicking My Apps in the upper right corner of the page.
The requirements to submit an app are listed below, as well as where the information needs to be updated.
Support resources should be available throughout the app experience, including in your onboarding flow and the app’s dashboard.
Make sure to reference BigCommerce using the proper formatting. You can visit our Media Kit for any BigCommerce branding assets needed.
The app and app listing should make no references to competitor platforms.
Use the brand name you’ve given your app for your app title throughout your app content. This listing name should be a concise title for easy identification and should not include additional taglines or descriptors. The name will always appear alongside your summary, so there’s no need to muddy your app’s branding with duplicate content when that tagline is already displayed with it!
- If your solution is a connector to a specific third-party service, or you’re offering only a specific feature, make sure to include both the name of the third party service or feature and your company name (Ex: “Marketplace by BigCommerce”, “Search by BigCommerce”), with your company name following the feature.
Your app, including any storefront components, should be compatible with all browsers that the BigCommerce platform supports.
Your app must work as intended, be free of defects, and not conflict with or break any default BigCommerce functionality, including the BigCommerce storefront and checkout.
Utilize any V3 API resources that are currently available for the data you need from a BigCommerce store.
The dashboard and callback URLs for your app should operate strictly over HTTPS using a valid SSL certificate.
Apps should offer multi-user support so that permissions for the app can be distributed by the store owner to additional users, from the BigCommerce control panel.
Any apps that process transactions or handle credit card data will need to pass a PCI Compliance review with our Security team, and also be compatible with our Optimized One-Page Checkout.
Avoid copy/paste for storefront code - use the Scripts API to programmatically inject code snippets into a store’s Script Manager and storefront theme.
If your app requires payment, you’ll need to collect payment from the user within your app. See Pricing & Categorization under App Summary for more information.
Apps should be Single-Click and use our OAuth token exchange flow to authenticate the user
Single-Click does not mean everything completed in one click, but that authentication is handled in that click - other tasks can be handled post-auth with the user
When the app is installed, a styled HTML page must be returned in the iframe of the BigCommerce control panel - this content cannot be blank and must follow our user-interface constraints.
During the OAuth handshake, be sure to store the user’s token against their store hash - rather than their email address - to avoid any problems with ownership changes or multi-user support.
If your app cannot meet these requirements, please reach out to email@example.com in order to discuss the potential for a Connector app listing. In the majority of cases, a Single-Click app will be the more appropriate solution and put your integration on par with other Marketplace partners, but exceptions may be made under certain circumstances
Have a form to fill out for new users? We recommend auto-filling user input fields with data from the Store Information API resource, which already contains much of the info you might need from a new user.
No account approval process needed for your app? Consider automatically generating accounts for stores that install your app and don’t match an existing store in your database.
Require login on launch? Use the information in the BigCommerce payload to your callback URL to authenticate the user without asking for a username and password each time.
Want to share user testimonials? Add a link to your full case study in the Case Studies field, with a title and short description.
Dev Tools Walkthrough
Below are the screens you will go through when submitting an app through DevTools. Each tab shows the page along with the fields and descriptions. Each field needs to have the correct information for the app to be approved.
Use the email address that was created when applying for your Partner Id.
List the name of your company, as you want it to be attributed on the detail page.
Provide the URL for your homepage so users can learn more about your company.
Email where users can get help with the app. This should be a formal group email at your company domain (Ex: firstname.lastname@example.org) rather than a personal email. If not provided, this option will not be displayed.
A Support email and website for users to reach out as needed. These will be publicly visible on the Marketplace, so make sure to stay away from personal emails or non-support URLs. Your public detail page will include a button for users to “Get Support,” which will take them to this URL in a new tab. If not provided, the button will not be displayed on your detail page.
When you’re ready to submit your listing for review, you will need to enter your Partner ID for your Technology Partner account. This field is not required to create, save, or edit a Draft prior to submission.
Use the brand name you’ve given your app for your app title throughout your app content. This listing name should be a concise title for easy identification and should not include additional taglines or descriptors. The name will always appear alongside your summary, so there’s no need to muddy your app’s branding with duplicate content when that tagline is already displayed with it.
Pricing & Categorization
Select one of our pre-formatted pricing options to call out your app’s starting price. If you offer a forever-free plan, choose the “Free” option. If your app does not fit one of our formatted options, specify your details in a few words in the “Other” selection.
- If you need to specify more detail on your pricing options, save it for your app description.
Choose the most appropriate category for your app.
If your solution is a connector to a specific third-party service, or you’re offering only a particular feature, make sure to include both the name of the third party service or feature and your company name (Ex: “Marketplace by BigCommerce,” “Search by BigCommerce”). The company name needs to follow the feature.
Your primary app logo should be 350 x 130px (or larger at this ratio) with a white background and dark branding in the foreground. The logo should only include branding, no taglines necessary.
The app icon will be included on the main app detail page and the sidebar in the BigCommerce control panel once the app is installed. This should be a square 200x200px image.
Select one of our pre-formatted pricing options to call out your app’s starting price. If you offer a forever-free plan, choose the “Free” option. If your app does not fit one of our options, specify your details in a few words in the “Other” selection.
If you need to specify more detail on your pricing options, save it for your app description.
A short tagline description of your app that will be used on your app card in category and search results within the Marketplace. 128 characters max.
Your app icon will be included on the main app detail page and the sidebar in the BigCommerce control panel once the app is installed. This should be a square 200 x 200px image.
Choose the most appropriate category for your app. Take a look at the live Marketplace for an idea of where solutions are currently assigned to help decide the right category. The category selection will also be a search attribute for your listing. BigCommerce will review your category assignment and may re-categorize your listing prior to launch. One category maximum.