Documentation API

API Kitsunova

Intégrez les audits web Kitsunova directement dans vos outils. Disponible sur le plan Agence.

Authentification

Passez votre clé API dans le header Authorization. Créez vos clés dans votre dashboard.

curl -X POST https://kitsunova.com/api/analyze \
-H "Authorization: Bearer kit_xxxxx" \
-H "Content-Type: application/json" \
-d '{"url":"https://exemple.com"}'

Workflow recommandé

POST /api/analyze

Crée l'audit, retourne id

POST /api/run

Lance l'analyse (fire-and-forget)

GET /api/status/:id

Poll jusqu'à status=complete

GET /api/report/:id

Récupère le rapport complet

Endpoints

POST

/api/analyzeLancer un audit🔑 Auth requise

Crée un audit pour l'URL donnée et retourne un identifiant. Déclenchez ensuite /api/run pour lancer l'analyse.

Body

{ "url": "https://exemple.com" }

Réponse

{ "id": "abc123..." }

POST

/api/runExécuter l'analyse

Lance l'analyse complète (20+ modules) pour un audit créé. Appel fire-and-forget — utilisez /api/status pour suivre la progression.

Body

{ "id": "abc123..." }

Réponse

{ "ok": true, "scoreGlobal": 74 }

GET

/api/status/:idStatut d'un audit

Retourne l'état actuel d'un audit en cours (pending, processing, complete, error) et l'étape courante.

Réponse

{ "status": "complete", "currentStep": "complete" }

GET

/api/report/:idRécupérer un rapport

Retourne les données complètes d'un rapport finalisé. Retourne 410 si le rapport a expiré.

Réponse

{ "id": "abc123", "url": "...", "scoreGlobal": 74, "scorePerformance": 68, "scoreSeo": 82, ... }

GET

/api/badge/:idBadge SVG

Retourne un badge SVG affichant le score global du rapport. Idéal pour vos READMEs ou sites.

Réponse

<svg>...</svg>  (image/svg+xml)

GET

/api/dashboardHistorique des audits🔑 Auth requise

Retourne la liste des audits de l'utilisateur connecté, avec tous les scores.

Réponse

{ "ok": true, "analyses": [{ "id": "...", "url": "...", "scoreGlobal": 74, ... }] }

GET

/api/dashboard/csvExport CSV🔑 Auth requise

Télécharge un fichier CSV de tous les audits de l'utilisateur avec leurs scores.

Réponse

id,url,createdAt,scoreGlobal,...

Limites

Gratuit

3 audits/mois

Pro

Illimité

Agence

Illimité + API