Setup
Background
The Beam integration aims to strengthen our partner brand’s positioning around their commitment to local communities, build community, and lift order frequency and AOV. The integration enables users to choose a nonprofit during purchase to which the partner will donate on their behalf.
Each transaction registers on the front end with Beam to enable immediate impact tracking. Our OMS APIs enable purchase confirmation, update and cancellation. Batch endpoints are available upon request.
Environment Base URLs
| Environment | URL |
|---|---|
| Production | https://api.beamimpact.com |
| Staging | https://api-staging.beamimpact.com |
API Keys
Beam has two API keys that are meant to be used for different endpoints. Note that these API keys are different between the staging and production environments.
Storefront API Key
The Storefront API key is utilized in the web widgets and certain APIs (detailed below).
Authorization: "Api-Key {{SDK API key received from Beam}}"
// This will look something similar to:
Authorization: "Api-Key abc123.xyz456"
OMS Integration API Key
The OMS integration API key is utilized in our backend endpoints and should not be included in any frontend code or widgets.
Authorization: "Api-Key {{Server API key received from Beam}}"
// This will look something similar to:
Authorization: "Api-Key abc123.xyz456"
🚧 This API Key should never be called from the frontend.
Server Error Codes
| Code | Meaning |
|---|---|
| 401 | API Key not provided |
| 403 | API Key provided is invalid or wrong |