|
| 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 | +--- |
0 commit comments