# Documentation de l’API

Lancez vos crawls, lisez chaque rapport et recevez les événements de vos projets depuis vos propres outils. Une API REST en JSON, versionnée, dont les quotas suivent votre offre.

URL de base: `https://api.nessflow.com/v1`

## Guides

- [Démarrage rapide](https://nessflow.com/fr/developpeurs/demarrage-rapide.md): Créez un jeton, faites votre premier appel à l’API NessFlow et lancez un crawl, en quelques minutes.
- [Authentification et scopes](https://nessflow.com/fr/developpeurs/authentification.md): Comment un jeton d’API s’authentifie, ce que ses scopes permettent, et comment l’offre et le rôle s’y ajoutent.
- [Les concepts de l’API](https://nessflow.com/fr/developpeurs/concepts.md): Équipe, projet, campagne, crawl, rapports et modules, et comment l’API les relie.
- [Lancer et suivre un crawl](https://nessflow.com/fr/developpeurs/lancer-un-crawl.md): Créer une campagne, lancer un crawl de façon sûre, suivre son avancement et savoir quand ses rapports sont prêts.
- [Lire les résultats d’un crawl](https://nessflow.com/fr/developpeurs/lire-les-resultats.md): Anomalies, pages et rapports d’un crawl, et la comparaison avec le précédent.
- [Exporter un rapport](https://nessflow.com/fr/developpeurs/exports.md): Demander le rapport PDF ou le classeur Excel d’un crawl, attendre qu’il soit prêt et le télécharger.
- [Recevoir les webhooks](https://nessflow.com/fr/developpeurs/recevoir-les-webhooks.md): Abonner une adresse aux événements, vérifier chaque envoi, répondre vite et gérer les relances.
- [Pagination](https://nessflow.com/fr/developpeurs/pagination.md): Parcourir une liste longue par curseur, sans total et sans page qui saute.
- [Gérer les erreurs](https://nessflow.com/fr/developpeurs/gerer-les-erreurs.md): Le format des erreurs, les codes stables, et ce qu’il faut faire selon la famille de l’erreur.
- [Idempotence](https://nessflow.com/fr/developpeurs/idempotence.md): Réessayer une écriture sans jamais la faire deux fois, grâce à l’en-tête Idempotency-Key.
- [Limites de débit](https://nessflow.com/fr/developpeurs/limites-de-debit.md): Comment le débit de l’API se mesure, par équipe et en unités de coût, et comment s’y adapter.
- [Versions et évolutions](https://nessflow.com/fr/developpeurs/versions.md): Ce qui peut changer dans la version 1 de l’API sans vous prévenir, et ce qui ne changera pas.
- [Bonnes pratiques d’intégration](https://nessflow.com/fr/developpeurs/bonnes-pratiques.md): Les habitudes qui rendent une intégration sûre, économe et robuste face aux erreurs.

## Référence de l’API

- [Compte](https://nessflow.com/fr/developpeurs/reference/account.md): Le jeton, son équipe, son offre et sa consommation.
- [Projets](https://nessflow.com/fr/developpeurs/reference/projects.md): Les projets (sites suivis dans le temps) et leur bilan de santé.
- [Campagnes](https://nessflow.com/fr/developpeurs/reference/campaigns.md): Les configurations de crawl réutilisables et leur planification.
- [Crawls](https://nessflow.com/fr/developpeurs/reference/crawls.md): Les crawls exécutés et leurs résultats : anomalies, pages, rapports.
- [Recommandations](https://nessflow.com/fr/developpeurs/reference/recommendations.md): Les recommandations IA, globales et par page.
- [Exports](https://nessflow.com/fr/developpeurs/reference/exports.md): Le rapport PDF et le classeur Excel d’un crawl, générés en tâche de fond.
- [Modules](https://nessflow.com/fr/developpeurs/reference/modules.md): Les modules hors score de santé (positions, Search Console, backlinks, sécurité, journaux). Ils portent une tendance, jamais une note.
- [Webhooks](https://nessflow.com/fr/developpeurs/reference/webhooks.md): Les événements sortants signés (crawl terminé, export prêt, recommandations prêtes, signal détecté). Gérés par les owners et admins de l’équipe.
- [Événements de webhook](https://nessflow.com/fr/developpeurs/webhooks.md)
- [Codes d’erreur](https://nessflow.com/fr/developpeurs/erreurs.md)
- [Journal des modifications](https://nessflow.com/fr/developpeurs/changelog.md)