Documentation

Construire avec Shugoi

Des guides précis et des exemples prêts à copier, de l’intégration à la production.

Clés API internes

La clé interne automatise la configuration ; elle est distincte de la siteKey et du secret du middleware. Créez-la dans le dashboard et copiez-la une seule fois.

Endpoints

HTTP
GET  /api/v1/internal/keys
POST /api/v1/internal/keys
DELETE /api/v1/internal/keys/:keyId
PATCH /api/v1/internal/sites/:siteKey/config
Authorization: Bearer <clé-api>

Payload et statuts

JSON
{"detectionFlags":{"enableWhitelist":true,"enableNativeErrorPages":false}}

200 appliqué ; 400 payload invalide ; 401 clé absente ou révoquée ; 403 opération non autorisée ; 404 site ou clé introuvable. Les écritures sont auditées, les caches invalidés et les flux WebSocket notifiés.

Rotation et sécurité

  1. Créer une nouvelle clé.
  2. Déployer la valeur via un secret manager.
  3. Vérifier l’appel puis révoquer l’ancienne.
  4. Ne jamais exposer la clé dans navigateur, Git, capture ou bundle client.

Besoin d’aide ? · Support · OpenAPI