The basics

This section explains the platform-wide rules that make BrowserBee predictable to integrate with.

BrowserBee API fundamentals

The BrowserBee API is designed around a small set of practical rules:

• use the correct environment base URL
• authenticate every request with a Bearer token
• send and receive JSON unless a specific endpoint documents otherwise
• treat resource identifiers as stable, machine-oriented values
• use the API Reference for endpoint detail and this section for platform rules

What every integration needs

Every BrowserBee client or service should know:

• which environment it is targeting
• which token it should use
• how it will handle transient failures
• how it will surface validation or operational errors

If one of those is unclear, integration work slows down later.

How to read the docs

Use BrowserBee docs in this order:

1. fundamentals for shared concepts
2. methods and parameters for request composition
3. integrations for auth, SDK, OpenAPI, and webhook workflows
4. API Reference for endpoint specifics

Recommended defaults

• start with the development environment
• use one token per environment and workload
• verify GET /browsers before building more complex flows
• keep request code simple at first, then centralize shared concerns into a wrapper

Next steps

• Continue to API structure.
• Continue to Connecting to the API.