B2C Cartridge Setup
1. Gather your Beam IDs and credentials
Most of Beam’s widgets and code implementations reference specific identifiers and credentials that will be necessary to communicate with the Beam system. Please ensure that you have all of these values readily available as you begin your implementation, and reach out to us if you need them!
Required
API Key
- This is the Beam SDK API Key used to communicate with Beam’s backend system. This is provided by Beam during initial setup, and will look similar to
abc123.xyz456
Chain ID
- This is a number that uniquely identifies your overall brand in Beam’s system. This is provided by Beam during initial setup
Store ID
- Store ID is a number that uniquely identifies individual locations, stores, websites, or a similar grouping of user activity to provide a particular set of nonprofits for selection to the user
Widget Version
- (Latest version: latest) See SDK Versions for more information on versioning.
Optional
Domain
- The “top domain” of your site (i.e.,
mystore.com), which is used to set cookies that can be read across subdomains. This is used to preserve nonprofit selections and AB test assignments if your storefront and checkout flows are on different subdomains likewww.mystore.com,checkout.mystore.com.
Statsig Client API Key
- This is an optional api key that is provided by Beam if the integration will be using A/B tests. This key is used to communicate with Statsig’s backend system, and will look similar to
client-abc123xyz456
Base Url
- This value can be used to point the widgets to Beam’s Staging environment, if needed. In most cases, Beam will provide a testing API key for you rather than using a separate environment. The staging URL is
https://api-staging.beamimpact.com. - The default value for
baseUrlishttps://api.beamimpact.com. You do not need to provide it unless you are using a different URL.
Postal Code + Country Code
- Postal Code and Country Code are used post-purchase for brands who want to show nonprofits related to the user's shipping address.
2. Add Beam IDs and credentials to your site preferences
One easy way to manage your Beam ids and credentials is to add them as custom site preferences in Business Manager.
You may follow the steps outlined in this Salesforce article to add new site preferences for each:
- Name:
storeId, Value: the Store ID provided by Beam - Name:
chainId, Value: the Chain ID provided by Beam - Name:
lang, Value: “en”, or one of our currently supported languages - Name:
apiKey, Value: the Beam SDK API Key provided by Beam - Name:
version, Value: the Widget Version as noted above by Beam
3. Install the Beam Salesforce B2C Cartridge
Beam has developed a Salesforce B2C Cartridge that can be used to quickly add the Beam widgets to your B2C storefront. You will find the code and installation instructions in our GitHub package
Follow the installation and configuration steps to set up your Beam configuration and initialization as well as add the Beam widgets to your storefront.
4. Integrate order verification
Beam has built a set of transaction verification APIs that will help ensure that all transactions captured by the Beam system are accurate and complete. This is a necessary component to ensure that our partners have the most precise reports and invoices possible.