Platform concepts
BrowserBee is easiest to integrate with when you treat it as a focused platform with a small number of important resource groups and a clear separation between environments.
Core resource groups
BrowserBee documentation and examples center around these concepts:
- Browser profiles for the resources your integration creates, reads, and manages most often
- API tokens for secure machine-to-machine access
- Webhooks for outbound notifications and event-driven workflows
- Operational checks for validating system availability and integration health
Even if your first implementation is small, these concepts shape how you model permissions, retries, automation, and rollout safety.
Environments
BrowserBee provides distinct API environments:
| Environment | Base URL | Typical use |
|---|---|---|
| Production | https://api.browserbee.com/api/v1 | live workloads, user-facing automation, durable integrations |
| Development | https://api-dev.browserbee.com/api/v1 | local development, exploratory integration work, pre-production validation |
The safest default is to start in development, validate your flow, then promote the same integration pattern to production with a separate token.
API-first workflow
The BrowserBee platform is designed so the same conventions carry across the API:
- HTTP resources are addressed with predictable paths
- authentication is consistent across endpoints
- JSON is the primary interchange format
- documentation flows from platform concepts to endpoint detail
That consistency is what makes it practical to start with curl and later move to generated clients or wrappers.
Recommended mental model
When planning a BrowserBee integration, think in this order:
- Environment: where will this code run first?
- Credential: which token should this workload use?
- Resource: which BrowserBee object is the first one you need to read or create?
- Traffic pattern: is this interactive, scheduled, or event-driven?
- Reliability: how will you handle validation failures, retries, and limits?
That sequence reduces rework because it aligns authentication, base URL, and resource access from the beginning.
Where to go next
- Read Common workflows for recommended implementation sequences.
- Use Quick Start if you want the shortest path to a working request.
- Read The basics if you want the shared API conventions.