> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Lab - Getting Started

Plan: Developer Foundations

Lesson 4 of 21 · 30 min

In order to work with Catalog API, you must have a proper setup in Postman (or another REST client). This lab will walk you through the steps needed to activate a free Postman account, create an OAuth token for your storefront, and correctly set up an environment in Postman.

### Prerequisites

* BigCommerce store (sandbox or live)
* Basic knowledge of APIs
* REST client (Postman)
* Access to the user account with Store Owner permissions

### In this lab, you will:

* Install Postman
* Create an OAuth token from your sandbox store's control panel
* Create a preset for request headers
* Create an environment in Postman for your sandbox store

## Getting Started with Postman

![Postman](/_fern-files/bigcommerce.docs.buildwithfern.com/06ad56a9d0958247053fc761075377adef5168a60af45e83249cba57b71fd898/assets/learn/catalog-rest-api/ium3gFOOYknydgAB.png)

### Create a Postman Account

1. **Navigate** to [postman.com](https://www.postman.com/)
2. **Click** *Sign up for Free*
3. **Fill out** the form provided

### Create an OAuth Token

1. **Log in** to your sandbox store
   > **Info**
   >
   > Make sure you are logging in using the user account with Store Owner permissions. For more information, see the [Store API Accounts](https://support.bigcommerce.com/s/article/Store-API-Accounts) article in the support portal.

2. **Navigate** to Settings > Store-level API Accounts

3. **Click** the Create API Account button

4. **Select** "V2/V3 API token" as the Token Type

5. **Type** a name for the API account

6. **Copy** the store hash from the API path

   > **Info**
   >
   > The store hash is the alphanumeric string in the **API path** between /stores/ and /v3/. This string uniquely identifies this store when sending requests to `https://api.bigcommerce.com/`
   >
   > **Example:**
   > API Path: `https://api.bigcommerce.com/stores/abcd1234/v3/`
   > Store Hash: abcd1234
   >
   > The store hash can also be found in your **Control Panel URL**.
   >
   > **Example:**
   > Control Panel URL: `https://store-abcd1234.mybigcommerce.com/`
   > Store Hash: abcd1234

7. **Save** the store hash somewhere that you can access to complete later steps in this lab activity

8. **Configure** OAuth scopes by making the adjustments below: under Products, **click** the modify button

9. **Click** the Save button

10. **Copy** the Access Token and store it in a place you can access later

![API credentials dialog](file:assets/learn/catalog-rest-api/unnamed-\(3\).png)

> **Info**
>
> A .txt file containing the same credentials will (on most browsers) automatically download to your computer.
>
> There is no way to re-display this pop-up after you select Done to dismiss it. So make sure you store your credentials – either by copying/pasting the contents of each field out of the pop-up, or by keeping the downloaded .txt file. Otherwise, you will need to repeat all the above steps to generate new credentials.
>
> From a security perspective, these credentials are sensitive – please treat them with the same caution that you would treat a private key or root password.

#### Create an Environment in Postman

> **Info**
>
> **What are environments?**
>
> While working with APIs, you will often need to have different setups. For example, your local machine, the development server, or the production API. Environments give you the ability to customize requests using variables. This way you can easily switch between different setups without changing your requests. You won't have to worry about remembering all those values once they are in Postman. Environments can be downloaded and saved as JSON files and uploaded later.
>
> * Source: [https://learning.postman.com/docs/sending-requests/variables/managing-environments/](https://learning.postman.com/docs/sending-requests/variables/managing-environments/)

1. If it is not already open, **open** Postman

2. In the Workspace menu on the left side of the page, **click** the Environments tab

   ![Postman environment tab](/_fern-img/a325f8a3e2c1775d266829b152458d5067f2c7fb2bffc29093c7ae8b343f6fce.webp)

3. **Click** the + button to create a new environment

4. **Type** a name, such as "My Sandbox Store" into the Environment Name field

5. **Create** the following variables:

   **Environment Variables**

   | Variable    | Type    | Initial Value                                            | Current Value                                            |
   | ----------- | ------- | -------------------------------------------------------- | -------------------------------------------------------- |
   | store\_hash | Default | Paste your store hash                                    | Paste your store hash                                    |
   | v3\_token   | Default | Paste your Access Token copied from API account creation | Paste your Access Token copied from API account creation |

6. **Click** Save

7. Before you make a call, you must **assign** the new environment. Above the Save button, **click** the drop down arrow next to "No Environment." **Select** your new environment to assign.

### Create a Preset for Request Headers

> **Info**
>
> Saving your request header information in a preset will allow you to quickly populate your request headers rather than having to re-enter this information.

1. **Open** Postman

2. **Navigate** to your workspace

3. **Click** + to open a new tab

4. **Click** on the Headers tab

5. **Click** on Presets

6. **Click** Manage Presets

7. **Click** Add

8. **Add** the following presets

   **Postman Presets**

   | Field        | Value              |
   | ------------ | ------------------ |
   | Accept       | `application/json` |
   | Content-Type | `application/json` |
   | X-Auth-Token | `{{v3_token}}`     |

9. **Click** Add to save

10. Before you make a call, you must **assign** the headers. In the headers tab, **click** Presets, and Select your new presets to assign.