Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SELFDEV-370: [update] Replace links #2083

Merged
merged 15 commits into from
Oct 24, 2023
10 changes: 5 additions & 5 deletions docs/api-docs/analytics/bodl-for-storefronts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This guide illustrates the basics of using BODL data in your integration. This a

For scripts to successfully use BODL to access storefront data, the following must be true:

- Enable BODL on the subject storefront using the control panel or the [GraphQL Admin API's Enable data layer mutation](/api-docs/store-management/graphql/data-layer#enable-data-layer)
- Enable BODL on the subject storefront using the control panel or the [GraphQL Admin API's Enable data layer mutation](/docs/store-operations/settings/data#enable-data-layer)
- The storefront must use a stencil theme
- If a merchant enables cookie tracking consent on the subject storefront, the shopper must consent to the [appropriate category](#category-of-consent)

Expand Down Expand Up @@ -65,8 +65,8 @@ When the shopper clicks a button to view the category page for a product, the fo

| Event field | Type | Description | BigCommerce data map |
|:---|:---|:---|:---|
| `category_id` | integer | ID of the category. | [Get all categories](/docs/rest-management/catalog/category#get-all-categories) <br /> `data.id` |
| `category_name` | string | Name of the category. | [Get all categories](/docs/rest-management/catalog/category#get-all-categories) <br /> `data.name` |
| `category_id` | integer | ID of the category. | [Get all categories](/docs/rest-catalog/categories#get-all-categories) <br /> `data.id` |
| `category_name` | string | Name of the category. | [Get all categories](/docs/rest-catalog/categories#get-all-categories) <br /> `data.name` |
| `channel_id` | integer | The BigCommerce channel ID. Channel ID of the channel where checkout is taking place. | [Get all channels](/docs/rest-management/channels#get-all-channels) <br /> `data.id` |
| `event_id` | string | Unique ID for each event instance. | Unique event ID generated by BigCommerce. |
| `line_items[]` | array of `line_item` objects | Items in the category. | See [line_item](#line_item-object-schema) object for event fields |
Expand Down Expand Up @@ -385,7 +385,7 @@ If a merchant enables cookie tracking consent, the shopper must provide consent

### Scripts API example

The following is an example request that uses the Scripts API to associate the example script with pages on a storefront. Send a request to the [Create a script](/docs/rest-management/scripts#create-a-script) endpoint. For more, see the [Scripts API article](/api-docs/store-management/scripts).
The following is an example request that uses the Scripts API to associate the example script with pages on a storefront. Send a request to the [Create a script](/docs/rest-management/scripts#create-a-script) endpoint. For more, see the [Scripts API article](/docs/integrations/scripts).

```http filename="Example request: Create a Script" showLineNumbers copy
POST https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/content/scripts
Expand All @@ -409,6 +409,6 @@ Accept: application/json

## Resources

- [Scripts API article](/api-docs/store-management/scripts)
- [Scripts API article](/docs/integrations/scripts)
- [Scripts API reference](/docs/rest-management/scripts#create-a-script)
- [Scripts Manager support article](https://support.bigcommerce.com/s/article/Using-Script-Manager)
12 changes: 6 additions & 6 deletions docs/api-docs/analytics/data-layer-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ keywords: GA4, ga4, data, graphql, admin, google analytics 4,

# Data Layer Settings in the GraphQL Admin API

The GraphQL Admin API's data layer setting allows BigCommerce to send data from BigCommerce-hosted storefronts to third-party analytics providers through [Big Open Data Layer](/api-docs/partner/analytics-solutions/bodl). Bigcommerce can build native integrations to analytics providers, such as Google Analytics 4, using the data layer. Partners may also build their own integrations using the data layer. In each case, you must first enable the data layer using the GraphQL Admin API. The data layer is enabled at the global level.
The GraphQL Admin API's data layer setting allows BigCommerce to send data from BigCommerce-hosted storefronts to third-party analytics providers through [Big Open Data Layer](/docs/integrations/hosted-analytics). Bigcommerce can build native integrations to analytics providers, such as Google Analytics 4, using the data layer. Partners may also build their own integrations using the data layer. In each case, you must first enable the data layer using the GraphQL Admin API. The data layer is enabled at the global level.

This guide shows you how to use the GraphQL Admin API's data layer queries and mutations. For full schema, see the [GraphQL Admin API reference](/graphql-admin-reference).
This guide shows you how to use the GraphQL Admin API's data layer queries and mutations. For full schema, see the [GraphQL Admin API reference](/graphql-admin/reference).

## Prerequisites

You need a [store-level API account](/api-docs/getting-started/api-accounts#store-level-api-accounts) that contains the following [OAuth scopes](/api-docs/getting-started/api-accounts#oauth-scopes):
You need a [store-level API account](/docs/start/authentication/api-accounts#store-level-api-accounts) that contains the following [OAuth scopes](/docs/start/authentication/api-accounts#oauth-scopes):

| UI Name | Permission | Parameter | Description |
|:--------|:-----------|:----------|:------------|
| Information & Settings | modify | `store_v2_information` | View and modify store information and settings |

For more about API accounts that generate `access_token`s, see [API Accounts and OAuth Scopes](/api-docs/getting-started/authentication/rest-api-authentication).
For more about API accounts that generate `access_token`s, see [API Accounts and OAuth Scopes](/docs/start/authentication).

## Get data layer

Expand Down Expand Up @@ -157,5 +157,5 @@ Send the following mutation to disable the data layer in the store:
</Tabs>

## Resources
- [GraphQL Admin API reference](/graphql-admin-reference)
- [Big Open Data Layer](/api-docs/partner/analytics-solutions/bodl)
- [GraphQL Admin API reference](/graphql-admin/reference)
- [Big Open Data Layer](/docs/integrations/hosted-analytics)
8 changes: 4 additions & 4 deletions docs/api-docs/apps/apps-id.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



Select partners [building channel apps](/api-docs/channels/guide/building-channel-apps) need to know their app's ID in order to create and modify the channel's configuration. This tutorial demonstrates how to find an app's ID in the [Developer Portal](#find-in-developer-portal) and the [control panel](#find-in-control-panel).
Select partners [building channel apps](/docs/integrations/channels/guide) need to know their app's ID in order to create and modify the channel's configuration. This tutorial demonstrates how to find an app's ID in the [Developer Portal](#find-in-developer-portal) and the [control panel](#find-in-control-panel).



Expand Down Expand Up @@ -63,6 +63,6 @@ Accept: application/json
```

## Resources
* [Building Apps Guide](/api-docs/getting-started/building-apps-bigcommerce/building-apps)
* [Building Channel Apps](/api-docs/channels/guide/building-channel-apps)
* [Extending Existing Apps with Channels Toolkit](/api-docs/channels/extending-existing-apps)
* [Building Apps Guide](/docs/integrations/apps)
* [Building Channel Apps](/docs/integrations/channels/guide)
* [Extending Existing Apps with Channels Toolkit](/docs/integrations/channels/guide/extending-existing-apps)
20 changes: 10 additions & 10 deletions docs/api-docs/apps/apps-quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ keywords: apps, app extensions, configuration, environment variables, env vars,

# BigCommerce Apps Quick Start

In this quick start tutorial, you will create a [single-click app](/api-docs/getting-started/building-apps-bigcommerce/types-of-apps) using [Node.js](https://nodejs.org/en/), [React](https://www.reactjs.org/), [Next.js](https://nextjs.org/), and [BigDesign](https://developer.bigcommerce.com/big-design).
In this quick start tutorial, you will create a [single-click app](/docs/integrations/apps/guide/types) using [Node.js](https://nodejs.org/en/), [React](https://www.reactjs.org/), [Next.js](https://nextjs.org/), and [BigDesign](https://developer.bigcommerce.com/big-design).

## Prerequisites

To successfully complete this tutorial, you will need the following:

* [BigCommerce sandbox store](/api-docs/partner/getting-started/create-a-sandbox-store) (required to develop and test apps)
* [BigCommerce sandbox store](/docs/start/about/sandboxes) (required to develop and test apps)
* [Developer Portal Account](https://devtools.bigcommerce.com/) (required to register apps)
* Experience using [npm](https://www.npmjs.com/)
* The most recent LTS version of Node.js and its highest corresponding npm version
Expand Down Expand Up @@ -53,7 +53,7 @@ Next, create a draft app profile in the [Developer Portal](https://devtools.bigc
6. Enter the **Load Callback URL** as `https://{ngrok_url}/api/load{:http}`.
7. Enter the **Uninstall Callback URL** as `https://{ngrok_url}/api/uninstall{:http}`.
8. If your app supports multiple users, locate the **App Features** section. Select **Multiple Users**, then enter the **Remove User Callback URL** as `https://{ngrok_url}/api/remove_user{:http}`.
9. Because you will be using the API to modify the store's products, set the Products OAuth scope to `modify`. To learn more about the available OAuth scopes, see [OAuth scopes](/api-docs/getting-started/api-accounts#oauth-scopes).
9. Because you will be using the API to modify the store's products, set the Products OAuth scope to `modify`. To learn more about the available OAuth scopes, see [OAuth scopes](/docs/start/authentication/api-accounts#oauth-scopes).
10. Click **Update & Close**.
11. Click **View Client ID** to view this app's client ID and client secret, or _app-level API account_.

Expand Down Expand Up @@ -156,18 +156,18 @@ Congrats! You've created and installed a BigCommerce draft app.

<Callout type="info">
#### Becoming a partner
Interested in sharing or selling your app? Learn more about [becoming a BigCommerce partner](https://www.bigcommerce.com/partners/become-a-partner) and [getting your app approved](/api-docs/partner/app-store-approval-requirements).
Interested in sharing or selling your app? Learn more about [becoming a BigCommerce partner](https://www.bigcommerce.com/partners/become-a-partner) and [getting your app approved](/docs/integrations/apps/guide/requirements).
</Callout>


## Next steps
* [Learn more about building apps](/api-docs/getting-started/building-apps-bigcommerce/building-apps)
* [Learn more about building apps](/docs/integrations/apps)
* [Apply to become a BigCommerce partner](https://www.bigcommerce.com/partners/become-a-partner)
* [Check out the BC App Marketplace approval requirements](/api-docs/partner/app-store-approval-requirements)
* [Check out the BC App Marketplace approval requirements](/docs/integrations/apps/guide/requirements)

## Resources
* [BC App Marketplace](https://www.bigcommerce.com/apps/)
* [Guide to API Accounts](/api-docs/getting-started/api-accounts)
* [Testing locally with ngrok](/api-docs/apps/guide/development#testing-locally-with-ngrok)
* [Types of apps](/api-docs/getting-started/building-apps-bigcommerce/types-of-apps)
* [Becoming a partner](/api-docs/partner/becoming-a-partner)
* [Guide to API Accounts](/docs/start/authentication/api-accounts)
* [Testing locally with ngrok](/docs/integrations/apps/guide#testing-locally-with-ngrok)
* [Types of apps](/docs/integrations/apps/guide/types)
* [Becoming a partner](/docs/start/partner)
16 changes: 8 additions & 8 deletions docs/api-docs/apps/guide/apps-01-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: apps, app extensions

# Introduction to Building Apps

Using BigCommerce's powerful APIs, SDKs, and toolkits, developers can build apps that are installable on BigCommerce stores. Once approved, apps can be sold (or made available free of charge) to all BigCommerce merchants on the [App Marketplace](https://www.bigcommerce.com/apps). This is the first article in a comprehensive developer's guide to building BigCommerce apps. It provides a brief, high-level introduction for developers new to the platform. If you already have experience developing for BigCommerce, feel free to [skip ahead](#next-steps) or check out the [quick start tutorial](/api-docs/apps/quick-start).
Using BigCommerce's powerful APIs, SDKs, and toolkits, developers can build apps that are installable on BigCommerce stores. Once approved, apps can be sold (or made available free of charge) to all BigCommerce merchants on the [App Marketplace](https://www.bigcommerce.com/apps). This is the first article in a comprehensive developer's guide to building BigCommerce apps. It provides a brief, high-level introduction for developers new to the platform. If you already have experience developing for BigCommerce, feel free to [skip ahead](#next-steps) or check out the [quick start tutorial](/docs/integrations/apps/quick-start).


## About BigCommerce apps
Expand Down Expand Up @@ -41,23 +41,23 @@ Use [BigCommerce APIs](/docs/api) to integrate stores with business systems such


### Connect to sales channels
List products on external [sales channels](https://www.bigcommerce.com/apps/categories/sales-channels/) with [Channels Toolkit](/api-docs/channels/guide/channels-toolkit-reference).
List products on external [sales channels](https://www.bigcommerce.com/apps/categories/sales-channels/) with [Channels Toolkit](/docs/integrations/channels/toolkit-reference).

[Learn more about connecting apps to sales channels.](/api-docs/channels/overview).
[Learn more about connecting apps to sales channels.](/docs/integrations/channels).

### Add and manage scripts
Create and manage scripts with [Scripts API](/docs/rest-management/scripts) and [Script Manager](https://support.bigcommerce.com/s/article/Using-Script-Manager).

[Learn more about creating scripts](/api-docs/store-management/scripts-overview).
[Learn more about creating scripts](/docs/integrations/scripts).

### Create custom widgets
Create [widgets](https://support.bigcommerce.com/s/article/Page-Builder#builder) for merchants to install and configure.

[Learn more about creating widgets](/api-docs/storefront/widgets/widgets-overview).
[Learn more about creating widgets](/docs/storefront/widgets).

## Getting started
Here's how to get started with BigCommerce development:
1. [Create a BigCommerce sandbox store](/api-docs/partner/getting-started/create-a-sandbox-store).
1. [Create a BigCommerce sandbox store](/docs/start/about/sandboxes).

2. [Apply to be a Partner](https://www.bigcommerce.com/partners) to get paid for your apps.

Expand All @@ -68,9 +68,9 @@ Here's how to get started with BigCommerce development:


## Next steps
* [Decide which type of app to build](/api-docs/apps/guide/types)
* [Decide which type of app to build](/docs/integrations/apps/guide/types)

* [Start building apps with Node, React, Next.js, and BigDesign](/api-docs/apps/quick-start)
* [Start building apps with Node, React, Next.js, and BigDesign](/docs/integrations/apps/quick-start)


## Resources
Expand Down
8 changes: 4 additions & 4 deletions docs/api-docs/apps/guide/apps-02-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ The app requests the user to grant permissions associated to scopes configured f

Once granted, the app can request a permanent `access_token` for making REST API requests on the user's behalf.

Single-click apps can use [App Extensions](/app-extensions/overview).
Single-click apps can use [App Extensions](/docs/integrations/apps/app-extensions).

## Connector
Connector apps use manual OAuth token creation instead of the single-click app flow. Store owners manually generate [store-level API credentials](/api-docs/getting-started/api-accounts#revoking-store-level-api-credentials) and enter them into the app's configuration. While single-click apps are recommended, the following use cases might not be compatible:
Connector apps use manual OAuth token creation instead of the single-click app flow. Store owners manually generate [store-level API credentials](/docs/start/authentication/api-accounts#revoking-store-level-api-credentials) and enter them into the app's configuration. While single-click apps are recommended, the following use cases might not be compatible:

- Customized integrations that vary per store.
- Integrations that do not provide any content for an iFrame.
Expand All @@ -44,12 +44,12 @@ There are three visibility options for apps: **Draft**, **Unlisted**, and **Publ


## Next steps
[Begin app development](/api-docs/apps/guide/development).
[Begin app development](/docs/integrations/apps/guide).

## Resources

### Related articles
* [Building Apps Quick Start](/api-docs/apps/quick-start)
* [Building Apps Quick Start](/docs/integrations/apps/quick-start)

### Sample apps
* [Node / React / Next.js](https://github.com/bigcommerce/sample-app-nodejs)
Expand Down
6 changes: 3 additions & 3 deletions docs/api-docs/apps/guide/apps-03-developing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ The BigCommerce team has developed an array of sample apps and tools to assist d

## Getting started
Here's a few things you'll need before beginning app development:
1. [BigCommerce sandbox store](/api-docs/partner/getting-started/create-a-sandbox-store) (required to test app installation)
1. [BigCommerce sandbox store](/docs/start/about/sandboxes) (required to test app installation)
2. [Developer Portal Account](https://devtools.bigcommerce.com/) (required to register apps)
3. [BigCommerce partnership](https://www.bigcommerce.com/partners/) (required to publish apps to marketplace)

## Beginning quickly
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](/api-docs/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/).
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/).

Alternatively, you can clone the GitHub repo for your preferred stack:

Expand Down Expand Up @@ -71,7 +71,7 @@ Any store registered to the same email as your [Developer Portal](https://devtoo
## Resources

### Related articles
* [Building Apps Quick Start](/api-docs/apps/quick-start)
* [Building Apps Quick Start](/docs/integrations/apps/quick-start)

### Sample apps
* [Node / React / Next.js](https://github.com/bigcommerce/sample-app-nodejs)
Expand Down
Loading