API partners & developers
A clean, versioned API for review intelligence.
Skip the scrapers. Build against a documented v1 REST API with signed webhooks, machine-to-machine OAuth and a private Zapier integration — all gated behind approval.
The problem, honestly
- Review data lives in a place your systems can't reliably reach.
- Homegrown scrapers break, drift and expose you to policy risk.
- There's no clean event feed for 'analysis completed' or 'recommendation created'.
What's available today
- API keys with a brr_test_ prefix, stored only as a secure hash. Live-key issuance is admin-gated behind a feature flag.
- Versioned REST API (v1) covering business analysis, recommendations, and account-scoped data. Business-bound access is enforced server-side.
- Outbound webhook platform with HMAC-SHA256 signatures, AES-256-GCM encrypted secrets, exponential backoff and audit logs.
- Machine-to-machine OAuth 2.0 client-credentials flow (HS256 JWT) as an additive auth path alongside API keys.
- Private Zapier integration with triggers (analysis.completed, analysis.failed, report.generated, recommendation.created), actions and searches.
- Self-service Developer Dashboard at /dashboard/developers for eligible users to manage keys, webhooks and view usage.
On the roadmap
Planned / Flag-gated
The foundation is in the codebase behind feature flags. These paths are not open by default.
- • Public OAuth 2.0 Authorization Code + PKCE flow for third-party apps (foundation shipped, currently disabled behind the oauth_authcode_enabled flag).
- • Public Zapier listing (currently private beta).
- • Live API keys (brr_live_) enabled globally once the live_keys_enabled flag is switched on.
How partner onboarding works
- STEP 1Request access
Contact us to be approved as a partner. You'll receive a test API key and access to the Developer Dashboard.
- STEP 2Build against v1
Use the REST API and webhook events. Verify HMAC signatures on every delivery — the spec is in the docs portal.
- STEP 3Move to production
When live keys are enabled for your workspace, you can issue a brr_live_ key and switch traffic over.
Want to build with Biz Review Radar?
Partner access is manual today. Contact us with a short description of what you want to build and we'll get you set up with a test key.