Ga naar inhoud

Website-Scan API

De BSR Website-Scan API is een server-naar-server-endpoint voor integratiepartners. Het analyseert een website en retourneert een deelbare BSR-analyse. Het staat los van de on-page widget — het is bedoeld voor het bouwen van integraties, niet om op een pagina in te sluiten.

POST https://bluestars.app/api/integrations/bsr-website-scan
Authorization: Bearer <your-api-key>
Content-Type: application/json
VeldVerplichtBeschrijving
idJaJe referentie/identifier voor deze scan.
emailJaContact-e-mail die bij de scan hoort.
websiteJaDe website-URL die geanalyseerd wordt.
packVersionNeeTegen welk BSR-pack er geanalyseerd wordt.
{
"id": "your-ref-123",
"email": "contact@example.com",
"website": "https://example.com",
"packVersion": "bsr4"
}

De aanroep is synchroon en kan 1–5 minuten duren (de scan doet echt werk), dus stel een ruime timeout in. Bij succes retourneert hij een deelbare analyse:

  • analyseUrl — een link naar de volledige analyse die je kunt delen.
  • analyseSummary — een korte samenvatting van het resultaat.

API-sleutels (bs_live_…) worden per tenant uitgegeven en beheerd onder Instellingen in het dashboard. Neem contact op met Bluestars als je toegang op partnerniveau nodig hebt.