You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/apps/guide/buttons.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Your button will link merchants to BigCommerce's install endpoint for your appli
24
24
25
25
## Rendering success and failure pages
26
26
27
-
Modify your web site's server-side code to serve either a success or failure page, depending on whether the external installation was successful or unsuccessful.
27
+
Modify your website's server-side code to serve either a success or failure page, depending on whether the external installation was successful or unsuccessful.
28
28
29
29
If you skip this step, your application will load in the iFrame created by your button. To ensure a good experience for your users, we strongly recommend that you return a confirmation page, instead of allowing your application to be loaded in that modal.
Copy file name to clipboardExpand all lines: docs/integrations/apps/guide/callbacks.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This article is a reference for endpoints to which we send event-driven callback
11
11
12
12
## Overview
13
13
14
-
Your app's front-end views render inside an iFrame in the store control panel, so your app has no native ability to listen for a few high-level events. To support your work, BigCommerce sends `GET` requests to callback routes in your app that correspond to three events: opening the app, uninstalling the app, and revoking a user's access to the app. Each request includes a signed JSON web token (_JWT_), which contains identifying information about the store and the user.
14
+
Your app's front-end views render inside an iFrame in the store control panel, so your app has no native ability to listen for a few high-level events. To support your work, BigCommerce sends `GET` requests to callback routes in your app that correspond to three events: opening the app, uninstalling the app, and revoking a user's access to the app. Each request includes a signed JSON web token (_JWT_), which contains identifying information about the store and the user.
15
15
16
16
Your app is only required to handle the `GET /auth{:http}` and `GET /load{:http}` endpoints, but we recommend writing handlers for the others, as well. Please see the corresponding detail sections that follow for more about the consequences of not handling optional callback endpoints.
17
17
@@ -26,7 +26,7 @@ The following table lists the app management callbacks that BigCommerce stores s
26
26
27
27
## Render the app with load
28
28
29
-
Once the store owner or authorized user installs your app, it appears on the **Apps** sub-menu list in their store control panel, as well as their authorized users' control panels. When a user clicks your app's listing or another referring UI component, BigCommerce dispatches a request to your app's `GET /load{:http}` endpoint. The following is an example request:
29
+
Once the store owner or authorized user installs your app, it appears on the **Apps** sub-menu list in their store control panel, as well as their authorized users' control panels. When a user clicks your app's listing or another referring UI component, BigCommerce dispatches a request to your app's `GET /load{:http}` endpoint. The following is an example request:
30
30
31
31
```http filename="Example request: /load callback from BigCommerce"
32
32
GET https://your_app.example.com/load?signed_payload_jwt={header_b64.payload_claims_b64.signature_b64}
@@ -98,8 +98,8 @@ The following is an example of the payload claims encoded in the `signed_payload
Copy file name to clipboardExpand all lines: docs/integrations/apps/guide/index.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Here's a few things you'll need before beginning app development:
11
11
3.[BigCommerce partnership](https://www.bigcommerce.com/partners/) (required to publish apps to marketplace)
12
12
13
13
## Beginning quickly
14
-
The fastest way to begin app development is by starting with one of our sample apps. You can follow our [Building Apps Quick Start Tutorial](/docs/integrations/apps/quick-start), either alone or in conjunction with [spinning up a Heroku instance](https://heroku.com/deploy?template=https://github.com/bigcommerce/sample-app-nodejs) that runs our [Node / React / Next.js sample app](https://github.com/bigcommerce/sample-app-nodejs/).
14
+
The fastest way to begin app development is by starting with one of our sample apps. You can follow our [Building Apps Quick Start Tutorial](/docs/integrations/apps/quick-start), either alone or in conjunction with [spinning up a Heroku instance](https://heroku.com/deploy?template=https://github.com/bigcommerce/sample-app-nodejs) that runs our [Node / React / Next.js sample app](https://github.com/bigcommerce/sample-app-nodejs/).
15
15
16
16
Alternatively, you can clone the GitHub repo for your preferred stack:
17
17
@@ -34,7 +34,7 @@ cd myapp # move into app dir
34
34
35
35
brew install ngrok/ngrok/ngrok # install ngrok using homebrew
36
36
37
-
ngrok config add-authtoken <TOKEN># Obtain your authtoken by going to https://dashboard.ngrok.com/get-started/your-authtoken
37
+
ngrok config add-authtoken <TOKEN># Obtain your authtoken by going to https://dashboard.ngrok.com/get-started/your-authtoken
38
38
39
39
npm install # install dependencies
40
40
@@ -61,8 +61,8 @@ Once you've exposed your app to the internet, you can register it as a draft app
61
61
Any store registered to the same email as your [Developer Portal](https://devtools.bigcommerce.com/my/apps) account can install your draft apps. Use the following steps to install:
62
62
63
63
1. Sign in to the store and navigate to **Apps** > **My Apps** > [**My Draft Apps**](https://login.bigcommerce.com/deep-links/manage/marketplace/apps/my-apps/drafts).
64
-
2. Click the draft app thumbnail to install the draft.
65
-
3. Once you click **Install**, BigCommerce will begin the OAuth flow by making a `GET` request to the app's `/auth` callback URL. If the app handles all the requests successfully, the app has been installed and you can begin feature development.
64
+
2. Click the draft app thumbnail to install the draft.
65
+
3. Once you click **Install**, BigCommerce will begin the OAuth flow by making a `GET` request to the app's `/auth` callback URL. If the app handles all the requests successfully, the app has been installed, and you can begin feature development.
66
66
67
67
## Next steps
68
68
*[Learn How Test App Authentication Locally with ngrok](https://medium.com/bigcommerce-developer-blog/how-to-test-app-authentication-locally-with-ngrok-149150bfe4cf)
BigDesignalsoprovidesasetofUXwritingguidelinestohelpyoucreateclearandconsistentcopyforyourapp's UI. These guidelines cover topics such as tone, voice, and terminology, and provide examples of how to write effective UI copy. You can use these guidelines to ensure that your app'sUIcopyalignswithBigCommerce's design language and provides a consistent user experience.
59
+
BigDesignalsoprovidesasetofUXwritingguidelinestohelpyoucreateclearandconsistentcopyforyourapp's UI. These guidelines cover topics such as tone, voice, and terminology, and provide examples of how to write effective UI copy. You can use these guidelines to ensure that your app'sUIcopyalignswithBigCommerce's design language and provides a consistent user experience.
1.**ServeappresourcesoverHTTPS:**BigCommerce's control panel is served over HTTPS. Your app must also be served over HTTPS, including any remote resources referenced (such as CSS, JS, and image files). If any resources are served over HTTP, the user'sbrowserwilldisplayamixedcontenterrorandrefusetorenderyourapp's UI in the control panel iFrame.
Apps that operate in the iFrame get strong preference during [App Marketplace](https://www.bigcommerce.com/apps/) consideration; however, we sometimes make exceptions for apps that need to interact with other services.
Copy file name to clipboardExpand all lines: docs/integrations/apps/guide/users.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Because you know the store owner or user's `email` and `ID` from the app install
27
27
-**Users**: Cannot `install` or `uninstall` apps. Users are permitted only to `load` the apps that a store owner authorized.
28
28
29
29
## The remove user request
30
-
Store owners can also remove users. This action generates a `GET` request to the remove user callback URL that you provided in the [Developer Portal](https://devtools.bigcommerce.com/my/apps). When this occurs, your app should remove the user identified in the request from it's records.
30
+
Store owners can also remove users. This action generates a `GET` request to the remove user callback URL that you provided in the [Developer Portal](https://devtools.bigcommerce.com/my/apps). When this occurs, your app should remove the user identified in the request from its records.
31
31
32
32
For details about remove user and load requests, see [Single-click App Callbacks](/docs/integrations/apps/guide/callbacks).
Copy file name to clipboardExpand all lines: docs/integrations/apps/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ Use [BigCommerce APIs](/docs/api) to integrate stores with business systems such
44
44
### Connect to sales channels
45
45
List products on external [sales channels](https://www.bigcommerce.com/apps/categories/sales-channels/) with [Channels Toolkit](/docs/integrations/channels/toolkit-reference).
46
46
47
-
[Learn more about connecting apps to sales channels.](/docs/integrations/channels).
47
+
[Learn more about connecting apps to sales channels](/docs/integrations/channels).
48
48
49
49
### Add and manage scripts
50
50
Create and manage scripts with [Scripts API](/docs/rest-management/scripts) and [Script Manager](https://support.bigcommerce.com/s/article/Using-Script-Manager).
Copy file name to clipboardExpand all lines: docs/integrations/apps/tutorial/nextjs-setup.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ For this tutorial, you need Node.js version 18+. To check your version of Node.j
15
15
node -v
16
16
```
17
17
18
-
If you do not have Node.js installed, you can download it from [nodejs.org (downloads)](https://nodejs.org/en/download/).
18
+
If you do not have Node.js installed, you can download it from [nodejs.org (downloads)](https://nodejs.org/en/download/).
19
19
20
20
## Set up a project directory
21
21
@@ -140,7 +140,7 @@ Next.js associates each file in the pages folder with a route based on the file'
140
140
141
141
Next.js allows you to use a theme provider and import CSS files from `node_modules`. In this tutorial, you integrate [BigDesign React components](https://developer.bigcommerce.com/big-design/) to give your app a distinct BigCommerce look and feel.
142
142
143
-
1. Next.js uses the `App` component to initialize pages. To override the default `App` component, add the `_app.tsx` file to the `pages` folder. This is where you initialize BigDesign.
143
+
1. Next.js uses the `App` component to initialize pages. To override the default `App` component, add the `_app.tsx` file to the `pages` folder. This is where you initialize BigDesign.
144
144
145
145
2. Open `_app.tsx` and import `GlobalStyles` from BigDesign and `AppProps` from Next.js.
0 commit comments