envs

BigCommerce — store API

bigcommerce/api · version 1

envs add bigcommerce/api

This declares the keys below in your catalog and sets none of them. A template is a schema for keys; it never carries a value.

Key Needed Kind Notes
BIGCOMMERCE_STORE_HASH required secret Names the store and appears in every API path. BigCommerce never says it may be published, so it stays with the credentials it travels with. All names here are convention.. where to get it
BIGCOMMERCE_CLIENT_ID required secret BigCommerce says to guard the client id and secret closely and that they never change, which makes a leak permanent unless the whole API account is deleted.. where to get it
BIGCOMMERCE_CLIENT_SECRET required secret BigCommerce says to be particularly careful with it because it both signs and decrypts the tokens it issues.. where to get it
BIGCOMMERCE_ACCESS_TOKEN optional secret BigCommerce says store-level tokens do not expire and cannot be manually invalidated, so replacing one means deleting the API account that holds it.. where to get it
BIGCOMMERCE_STOREFRONT_API_TOKEN optional config BigCommerce says storefront tokens are designed for use from a web browser. Its private sibling is the opposite: sensitive, never to be exposed, treated like any other application secret.. where to get it

The JSON the CLI reads