Référence API

Endpoints de l'API Korvus pour l'ingestion de données et la récupération d'alertes.

Authentification

Toutes les requêtes vers l'API Korvus doivent inclure votre clé API dans le header :

X-API-Key: votre_cle_api

Endpoints

POST /api/collect

Endpoint principal pour l'ingestion de données. Utilisé automatiquement par le snippet JavaScript.

Headers :

  • Content-Type: application/json
  • X-API-Key: votre_cle_api

Body :

{
  "type": "pageview",
  "url": "https://example.com/products/chaussures",
  "referrer": "https://example.com/collections/hommes",
  "userAgent": "Mozilla/5.0...",
  "timestamp": "2026-03-15T10:30:00Z"
}

Types d'événements supportés :

TypeDescription
session_startDébut de session visiteur
pageviewPage vue avec URL, timing, type de page
purchaseTransaction avec montant et devise
tag_firedPixel de conversion déclenché
out_of_stock_viewedPage produit en rupture vue

GET /api/health

Endpoint de santé. Pas d'authentification requise.

Réponse :

{
  "status": "ok",
  "timestamp": "2026-03-15T10:30:00Z"
}

Limites

LimiteValeur
Requêtes par seconde100/s par clé API
Taille du body100 KB max
Événements par batch50 max

Codes d'erreur

CodeSignification
200Succès
400Payload invalide (voir message d'erreur)
401Clé API manquante ou invalide
429Rate limit dépassé
500Erreur serveur