Website-Scan API

The BSR Website-Scan API is a server-to-server endpoint for integration partners. It analyzes a website and returns a shareable BSR analysis. It is separate from the on-page widget — it’s for building integrations, not for embedding on a page.

Partner integration

This API is for backend integrations and requires an API key. Don’t call it from the browser — your key must stay server-side.

Endpoint

POST https://bluestars.app/api/integrations/bsr-website-scan
Authorization: Bearer <your-api-key>
Content-Type: application/json

Request body

Field	Required	Description
id	Yes	Your reference/identifier for this scan.
email	Yes	Contact email associated with the scan.
website	Yes	The website URL to analyze.
packVersion	No	Which BSR pack to analyze against.

{
  "id": "your-ref-123",
  "email": "contact@example.com",
  "website": "https://example.com",
  "packVersion": "bsr4"
}

Response

The call is synchronous and can take 1–5 minutes (the scan does real work), so set a generous timeout. On success it returns a shareable analysis:

• analyseUrl — a link to the full analysis you can share.
• analyseSummary — a short summary of the result.

Getting a key

API keys (bs_live_…) are issued per tenant and managed under Instellingen in the dashboard. Contact Bluestars if you need partner-level access.