Documentation

Build with Shugoi

Precise guides and copy-ready examples, from integration to production.

Automated testing

Test locally with a dedicated database, then in production with separate secrets. Always restore configuration in a finally block.

Playwright / Node.js

test.spec.ts

const response = await request.patch(
  API_BASE + "/internal/sites/" + SITE_KEY + "/config",
  { headers: { Authorization: "Bearer " + process.env.SHUGOI_API_KEY },
    data: { detectionFlags: { enableNativeErrorPages: false } } }
);
expect(response.status()).toBe(200);

cURL, Puppeteer et Selenium

Terminal

curl -i https://example.test
# Vérifier statut, titre, rendu SSR et WebSocket.
# Ne jamais injecter la clé dans page.evaluate().

Scénarios et dépannage

whitelist et native error pages on/off
rendu SSR et bootstrap WebSocket
clé révoquée puis refusée
réponses 200/400/401/403/404
Tor, headless et navigateur normal

Check HTTP status, console, MIME type, WebSocket and SDK version. Redact secrets and use a key identifier.

Need help? · Support · OpenAPI