Skip to content

Commit db0eaa6

Browse files
fix(webapp): don't prefill overrideAuthParams with integration defaults on connection create (#6990)
## Describe the problem and your solution - don't prefill overrideAuthParams with integration defaults on connection create - Migrate bigcommerce docs to use new format. <!-- Issue ticket number and link (if applicable) --> <!-- Testing instructions (skip if just adding/editing providers) --> <!-- This is an auto-generated description by cubic. --> <a href="https://cubic.dev/pr/NangoHQ/nango/pull/6990?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. -->
1 parent fe95cdd commit db0eaa6

11 files changed

Lines changed: 181 additions & 85 deletions

File tree

docs/api-catalog.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ URL patterns:
109109
| `beehiiv` | Beehiiv | API_KEY | [docs](https://nango.dev/docs/integrations/all/beehiiv.md) | | | communication, marketing |
110110
| `bettercontact` | BetterContact | API_KEY | [docs](https://nango.dev/docs/api-integrations/bettercontact.md) | [connect](https://nango.dev/docs/api-integrations/bettercontact/connect.md) | | crm |
111111
| `bigchange` | BigChange | OAUTH2_CC | [docs](https://nango.dev/docs/api-integrations/bigchange.md) | [connect](https://nango.dev/docs/api-integrations/bigchange/connect.md) | | productivity |
112-
| `bigcommerce` | BigCommerce | OAUTH2 | [docs](https://nango.dev/docs/integrations/all/bigcommerce.md) | | | e-commerce |
112+
| `bigcommerce` | BigCommerce | OAUTH2 | [docs](https://nango.dev/docs/api-integrations/bigcommerce.md) | [connect](https://nango.dev/docs/api-integrations/bigcommerce/connect.md) | [setup](https://nango.dev/docs/api-integrations/bigcommerce/how-to-register-your-own-bigcommerce-api-oauth-app.md) | e-commerce |
113113
| `bill` | Bill (Connect API) | BILL | [docs](https://nango.dev/docs/integrations/all/bill.md) | | | payment |
114114
| `bill-sandbox` | Bill (Connect API Sandbox) | BILL | [docs](https://nango.dev/docs/integrations/all/bill-sandbox.md) | [connect](https://nango.dev/docs/integrations/all/bill-sandbox/connect.md) | | payment |
115115
| `bing-webmasters` | Bing Webmasters | OAUTH2 | [docs](https://nango.dev/docs/api-integrations/bing-webmasters.md) | | [setup](https://nango.dev/docs/api-integrations/bing-webmasters/how-to-register-your-own-bing-webmasters-api-oauth-app.md) | dev-tools |
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: 'BigCommerce'
3+
sidebarTitle: 'BigCommerce'
4+
description: 'Integrate your application with the BigCommerce API'
5+
---
6+
7+
## 🚀 Quickstart
8+
9+
Connect to BigCommerce with Nango and see data flow in 2 minutes.
10+
11+
<Steps>
12+
<Step id="create-integration" title="Create the integration">
13+
In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> _Configure New Integration_ -> _BigCommerce_. Enter the Client ID and Client Secret from your BigCommerce app (see the setup guide below).
14+
</Step>
15+
<Step id="authorize-bigcommerce" title="Authorize BigCommerce">
16+
Go to [Connections](https://app.nango.dev/dev/connections) -> _Add Test Connection_ -> _Authorize_, then enter the store's Store Hash (see the connect guide below for where to find it) and log in to BigCommerce to approve access. Later, you'll let your users do the same directly from your app.
17+
</Step>
18+
<Step id="call-bigcommerce-api" title="Call the BigCommerce API">
19+
Let's make your first request to the BigCommerce API (fetch a list of orders). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):
20+
<Tabs>
21+
<Tab title="cURL">
22+
23+
```bash
24+
curl "https://api.nango.dev/proxy/v2/orders" \
25+
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
26+
-H "Provider-Config-Key: <INTEGRATION-ID>" \
27+
-H "Connection-Id: <CONNECTION-ID>"
28+
```
29+
30+
</Tab>
31+
32+
<Tab title="Node">
33+
34+
Install Nango's backend SDK with `npm i @nangohq/node`. Then run:
35+
36+
```typescript
37+
import { Nango } from '@nangohq/node';
38+
39+
const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
40+
41+
const res = await nango.get({
42+
endpoint: '/v2/orders',
43+
providerConfigKey: '<INTEGRATION-ID>',
44+
connectionId: '<CONNECTION-ID>'
45+
});
46+
47+
console.log(res.data);
48+
```
49+
</Tab>
50+
51+
</Tabs>
52+
Or fetch credentials with the [Node SDK](/reference/backend/backend-sdk/node#get-a-connection-with-credentials) or [API](/reference/backend/http-api/connection/get).
53+
54+
✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
55+
</Step>
56+
57+
<Step id="implement-nango" title="Implement Nango in your app">
58+
Follow our [Auth implementation guide](/guides/auth/auth-guide) to integrate Nango in your app.
59+
60+
To obtain your own production credentials, follow the setup guide linked below.
61+
</Step>
62+
</Steps>
63+
64+
## 📚 BigCommerce Integration Guides
65+
66+
Nango maintained guides for common use cases.
67+
68+
- [How to register your own BigCommerce OAuth app](/api-integrations/bigcommerce/how-to-register-your-own-bigcommerce-api-oauth-app)
69+
Register an OAuth app with BigCommerce and obtain credentials to connect it to Nango
70+
71+
- [How to link your BigCommerce account](/api-integrations/bigcommerce/connect)
72+
Find your store's Store Hash to connect your BigCommerce account to Nango
73+
74+
Official docs: [BigCommerce API documentation](https://docs.bigcommerce.com/developer/docs/overview/quick-start)
75+
76+
## 🧩 Pre-built syncs & actions for BigCommerce
77+
78+
Enable them in your dashboard. Extend and customize to fit your needs.
79+
80+
import PreBuiltUseCases from "/snippets/generated/bigcommerce/PreBuiltUseCases.mdx"
81+
82+
<PreBuiltUseCases />
83+
84+
---
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: BigCommerce - How do I link my account?
3+
sidebarTitle: BigCommerce
4+
---
5+
6+
# Overview
7+
8+
To authenticate with BigCommerce, you will need:
9+
1. **Store Hash** - The unique identifier for your BigCommerce store.
10+
11+
### Prerequisites:
12+
13+
- You must have a BigCommerce store.
14+
15+
### Instructions:
16+
17+
#### Step 1: Finding your Store Hash
18+
19+
Log in to your BigCommerce account and look at your browser's address bar — your Store Hash is the part right after `store-` (e.g. `https://store-abc123.mybigcommerce.com/...``abc123`).
20+
21+
#### Step 2: Enter your credentials in the Connect UI
22+
23+
Once you have your **Store Hash**:
24+
1. Open the form where you need to authenticate with BigCommerce.
25+
2. Enter your **Store Hash** in the corresponding field.
26+
3. Submit the form, then log in to BigCommerce to approve access.
27+
28+
<img src="/api-integrations/bigcommerce/form.png" style={{maxWidth: "450px" }}/>
29+
30+
You are now connected to BigCommerce.
34 KB
Loading
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: 'How to register your own BigCommerce OAuth app'
3+
sidebarTitle: 'BigCommerce Setup'
4+
description: 'Register an OAuth app with BigCommerce and connect it to Nango'
5+
---
6+
7+
This guide shows you how to register your own app with BigCommerce to obtain your OAuth credentials (client ID, client secret, and account UUID). These are required to let your users grant your app access to their BigCommerce store.
8+
9+
<Steps>
10+
<Step title="Create a developer account">
11+
Go to the [BigCommerce Developer Portal](https://devtools.bigcommerce.com/) and sign up for a developer account.
12+
</Step>
13+
<Step title="Create a new app">
14+
Click **+ Create App**, then enter a name for your app. BigCommerce apps can be single-store (private, no review required) or listed on the App Marketplace, which requires going through BigCommerce's [marketplace approval process](https://docs.bigcommerce.com/developer/docs/integrations/apps/guide/approval-requirements). If you only need to connect your own store, a single-store app avoids that process entirely.
15+
</Step>
16+
<Step title="Copy your generated credentials">
17+
Once the app is created, BigCommerce generates your **Client ID**, **Client Secret**, and **Account UUID** together. Copy all three — you'll need them when configuring the BigCommerce integration in Nango.
18+
19+
<Note>The Account UUID belongs to your developer app, not to any single merchant's store. It's the same value for every connection made through this integration — see the last step below for how to apply it automatically without asking each user for it.</Note>
20+
</Step>
21+
<Step title="Configure the callback URL">
22+
In your app's **App Information** tab, set the auth callback URL to `https://api.nango.dev/oauth/callback`. Then, in the **Scopes** tab, select the OAuth scopes your integration needs — these should match the ones you select in Nango.
23+
</Step>
24+
<Step title="Apply the Account UUID to every connection">
25+
Since the Account UUID is fixed for your app, set it once as a [connection config default](/reference/backend/http-api/connect/sessions/create) instead of collecting it from each user. Pass it under `integrations_config_defaults` when creating a connect session:
26+
27+
```json
28+
{
29+
"integrations_config_defaults": {
30+
"<INTEGRATION-ID>": {
31+
"connection_config": {
32+
"accountUuid": "<YOUR-ACCOUNT-UUID>"
33+
}
34+
}
35+
}
36+
}
37+
```
38+
39+
Every connection created from that session will use this value automatically — your users only need to provide their **Store Hash** (see [how to link a BigCommerce account](/api-integrations/bigcommerce/connect)).
40+
</Step>
41+
<Step title="Next">
42+
Follow the [_Quickstart_](/getting-started/quickstart) to connect your first account.
43+
</Step>
44+
</Steps>
45+
46+
For more details, see [BigCommerce's OAuth documentation](https://docs.bigcommerce.com/developer/docs/integrations/apps/guide/auth).
47+
48+
---

docs/docs.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@
110110
"source": "/integrations/all/servicenow",
111111
"destination": "/api-integrations/servicenow"
112112
},
113+
{
114+
"source": "/integrations/all/bigcommerce",
115+
"destination": "/api-integrations/bigcommerce"
116+
},
113117
{
114118
"source": "/introduction",
115119
"destination": "/"
@@ -1040,7 +1044,7 @@
10401044
"api-integrations/bettercontact",
10411045
"api-integrations/bigchange",
10421046
"api-integrations/bliro",
1043-
"integrations/all/bigcommerce",
1047+
"api-integrations/bigcommerce",
10441048
"integrations/all/bill",
10451049
"integrations/all/bill-sandbox",
10461050
"integrations/all/bitbucket",

docs/integrations/all/bigcommerce.mdx

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/llms-full.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14750,7 +14750,7 @@ Use these slugs to construct provider-specific docs URLs only when needed.
1475014750
| `beehiiv` | Beehiiv | API_KEY | [docs](https://nango.dev/docs/integrations/all/beehiiv.md) | | | communication, marketing |
1475114751
| `bettercontact` | BetterContact | API_KEY | [docs](https://nango.dev/docs/api-integrations/bettercontact.md) | [connect](https://nango.dev/docs/api-integrations/bettercontact/connect.md) | | crm |
1475214752
| `bigchange` | BigChange | OAUTH2_CC | [docs](https://nango.dev/docs/api-integrations/bigchange.md) | [connect](https://nango.dev/docs/api-integrations/bigchange/connect.md) | | productivity |
14753-
| `bigcommerce` | BigCommerce | OAUTH2 | [docs](https://nango.dev/docs/integrations/all/bigcommerce.md) | | | e-commerce |
14753+
| `bigcommerce` | BigCommerce | OAUTH2 | [docs](https://nango.dev/docs/api-integrations/bigcommerce.md) | [connect](https://nango.dev/docs/api-integrations/bigcommerce/connect.md) | [setup](https://nango.dev/docs/api-integrations/bigcommerce/how-to-register-your-own-bigcommerce-api-oauth-app.md) | e-commerce |
1475414754
| `bill` | Bill (Connect API) | BILL | [docs](https://nango.dev/docs/integrations/all/bill.md) | | | payment |
1475514755
| `bill-sandbox` | Bill (Connect API Sandbox) | BILL | [docs](https://nango.dev/docs/integrations/all/bill-sandbox.md) | [connect](https://nango.dev/docs/integrations/all/bill-sandbox/connect.md) | | payment |
1475614756
| `bing-webmasters` | Bing Webmasters | OAUTH2 | [docs](https://nango.dev/docs/api-integrations/bing-webmasters.md) | | [setup](https://nango.dev/docs/api-integrations/bing-webmasters/how-to-register-your-own-bing-webmasters-api-oauth-app.md) | dev-tools |

docs/snippets/generated/bigcommerce/PreBuiltTooling.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
| Auth parameters validation ||
99
| Pre-built authorization UI ||
1010
| Custom authorization UI ||
11+
| End-user authorization guide ||
1112
| Expired credentials detection ||
1213
</Accordion>
1314
<Accordion title="✅ Read & write data">

packages/providers/providers.yaml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3273,19 +3273,23 @@ bigcommerce:
32733273
grant_type: authorization_code
32743274
proxy:
32753275
base_url: https://api.bigcommerce.com/stores/${connectionConfig.storeHash}
3276-
docs: https://nango.dev/docs/integrations/all/bigcommerce
3276+
headers:
3277+
x-auth-token: ${accessToken}
3278+
docs: https://nango.dev/docs/api-integrations/bigcommerce
3279+
docs_connect: https://nango.dev/docs/api-integrations/bigcommerce/connect
3280+
setup_guide_url: https://nango.dev/docs/api-integrations/bigcommerce/how-to-register-your-own-bigcommerce-api-oauth-app
32773281
connection_config:
32783282
storeHash:
32793283
type: string
32803284
title: Store Hash
3281-
description: The store hash of your BigCommerce account
3285+
example: hpj4hvw2bb
3286+
description: The store hash of your BigCommerce account.
32823287
pattern: '^[a-zA-Z0-9]+$'
32833288
accountUuid:
32843289
type: string
3285-
title: Account UUID
3286-
description: The account UUID of your BigCommerce account
3287-
format: uuid
3288-
example: 123e4567-e89b-12d3-a456-426614174000
3290+
title: ''
3291+
description: ''
3292+
automated: true
32893293

32903294
bill-sandbox:
32913295
display_name: Bill (Connect API Sandbox)

0 commit comments

Comments
 (0)