Overview
Learn how to set up and launch your integration with BFG APIs.
BFG provides a list of APIs that help you onboard stores, manage product catalogs, sync inventory, enforce MAP pricing, and support firearm compliance through FFL.
Start your BFG API onboarding and integration by following these steps:
- Request a BFG account.
- Select an environment.
- Generate your API credentials.
- Configure webhooks.
- Learn about the API structure.
- Integrate with BFG APIs.
- Read about other resources.
Step 1: Request a BFG account
To begin, contact BFG for an account. Your account will include:
- An account ID – used in most API requests
- Access to the BFG environments
- Permissions to access and manage APIs
Step 2: Select an environment
BFG provides two environments:
| Environment | Base URL | Desription |
|---|---|---|
| Sandbox | https://api-sandbox.buyingfreedom.app | Development and testing |
| Production | https://api.buyingfreedom.app | Live transactions |
Start in the sandbox environment to test your integration. Move to production when you're ready to go live.
Step 3: Generate your API credentials
All API requests require authentication using an API key and bearer token.
Note: Keep your secret keys secure. Don’t expose them in client-side code.
Step 4: Configure webhooks and roles
Use webhooks to receive real-time updates for catalog changes, policy assignments, or inventory actions. And then assign roles to control what users can view and manage across BFG.
Step 5: Learn about the API structure
BFG follows REST conventions with JSON responses.
Use standard HTTP status codes and structured error messages to handle failures.
Step 6: Integrate with BFG APIs
With BFG APIs, you can do the following:
- Publish MAP policy and related promotional product information.
- Access and manage product data.
- Organize products into categories.
- Push inventory updates to provide stock information.
- Verify regulated products according to federal guidelines.
- Create and manage stores.
- Get your
account_idand onboard your store to BFG's store locator.
Step 7: Read about other resources
Learn about best practices in consuming BFG APIs and how to set up Coreware workflows for updating product inventory.
Updated 3 months ago