Documentation

Tout ce qu'il faut pour démarrer avec Citaire

Guide compact et pragmatique. Pas de longs tutoriels — on va à l'essentiel.

Exemple API

Listez vos projets depuis n'importe quel script. Remplacezcit_live_xxxxxpar la clé créée depuis /compte/api-keys.

curl -H "Authorization: Bearer cit_live_xxxxx" \
     https://citaire.fr/api/v1/projects

# Liste les projets
# → { "projects": [ { "id": "...", "name": "...", ... } ] }

Déclencher un scan :

curl -X POST \
     -H "Authorization: Bearer cit_live_xxxxx" \
     https://citaire.fr/api/v1/projects/PROJECT_ID/scans

# → 202 Accepted
# { "scan": { "id": "...", "cited_count": 5, "total_results": 15, ... } }

Webhooks

À chaque scan terminé, Citaire envoie un POST à l'URL que vous avez configurée dans /parametresde votre projet. Format JSON par défaut (signé HMAC-SHA256), ou format Slack/Discord (collez directement une URL d'incoming-webhook).

POST https://votre-endpoint.example.com/webhook
Content-Type: application/json
X-Citaire-Event: scan.completed
X-Citaire-Signature: sha256=<HMAC du body avec votre secret>

{
  "event": "scan.completed",
  "delivered_at": "2026-05-28T10:00:00Z",
  "data": {
    "scan_id": "...", "project_id": "...", "project_name": "Cabinet Durand",
    "total_results": 15, "cited_count": 2, "citation_rate": 0.13
  }
}

Pour Slack/Discord, collez l'URL d'incoming-webhook et choisissez le format Slack/Discord: on envoie le message au bon format, prêt à s'afficher dans votre canal.

Badge embeddable

Affichez votre score de visibilité IA sur votre site avec une image SVG :

<img src="https://citaire.fr/embed/<projectId>/badge.svg"
     alt="Citaire — visibilité IA" />

Personnalisez la couleur et le nom affiché depuis /parametres → Marque blanche du badge.

Une question ? Contactez-nous — on répond en français, sous 24 h ouvrées.