#080Technique3 min
Découvrir l’API Hackaiz
Comprendre les routes à clé personnelle, les demandes asynchrones et les limites avant de créer une intégration.
Équipe Hackaiz · mis à jour le 21/11/2026

01Prévoir un usage autorisé du compte
Le projet contient des routes HTTP versionnées sous /api/public/v1. Elles couvrent notamment la liste des plateformes, les demandes d’analyse, leur état et les constats, ainsi que les examens de dossiers et de composants. Le mot public désigne ici l’espace de routes, pas un accès anonyme aux rapports d’autrui. Le client connecté et l’extension constituent des exemples concrets d’utilisation ; leurs sources permettent de consulter les structures de requêtes réellement prises en charge.
Choisissez le mode d’intégration avant de développer. Le serveur MCP distant /mcp utilise OAuth pour les assistants. Le client en ligne de commande et l’extension utilisent une clé personnelle. Une intégration limitée à la lecture d’une plateforme n’obtient pas automatiquement le droit de lancer des analyses partout. N’échangez pas ces moyens d’accès et ne copiez pas une session d’assistant dans un script. Limitez les autorisations et consignez les identifiants des plateformes volontairement accessibles.
02Garder les identifiants hors des fichiers du projet
Le client connecté transmet la clé personnelle dans l’en-tête Authorization selon le schéma Bearer. La variable d’environnement utilisée est HACKAIZ_API_KEY ; la clé commence par hkz_. Les clés se gèrent dans les paramètres Hackaiz, rubrique Intégrations. Le serveur vérifie le propriétaire, les permissions et les plateformes autorisées, au lieu de faire confiance au seul identifiant reçu. La lecture et le lancement sont distincts ; un accès expiré ou révoqué ne constitue jamais une réussite temporaire.
Conservez la clé dans l’environnement d’exécution ou le coffre à secrets du système d’automatisation. Évitez les fichiers du dépôt, les adresses de requête, les captures et les journaux. Le client impose une origine HTTPS et refuse les redirections. Reprenez cette précaution pour éviter qu’une destination modifiée reçoive silencieusement l’en-tête d’authentification. Pour expliquer une erreur, notez la route et le message nettoyé, pas une copie complète de la requête authentifiée.
03Suivre une demande au lieu de relancer le travail
Le client envoie une demande à /api/public/v1/projects/{projectId}/analysis-requests avec request_key et un canal, puis consulte /api/public/v1/projects/{projectId}/analysis-runs/{runId}. Le champ requestId renvoyé identifie la demande existante. Conservez-le avec votre clé de demande stable. Si la connexion tombe après le démarrage, consultez cette même demande au lieu d’en créer une autre susceptible de déclencher un travail supplémentaire utilisant des crédits.
Une demande acceptée n’est pas un résultat de sécurité terminé. Le traitement peut réussir, rester partiel ou échouer ; le client préparé signale aussi une configuration autonome manquante. La page Intégrations indique que le traitement autonome doit être déployé et synchronisé, sans confirmer un essai sur un véritable compte client. Un rapport partiel ne prouve pas une couverture complète. Prévoyez donc un état non concluant plutôt que de traduire une absence de données par une absence de vulnérabilité.
04Lire les résultats sans perdre les garanties de contrôle
Les constats sont accessibles par /api/public/v1/projects/{projectId}/findings. La vérification du client filtre sur l’analyse liée à la demande et parcourt les pages au lieu de considérer la première comme complète. Si vous créez un contrôle avant publication, préservez ce lien entre demande, analyse et constats. Une analyse de plateforme enregistrée ne vérifie pas automatiquement le commit d’une proposition GitHub ni un déploiement particulier. Indiquez cette limite dans l’état présenté à votre équipe.
Les analyses utilisent des crédits. Les sites et API demandent une preuve de domaine par TXT DNS _hackaiz, fichier HTTPS de vérification ou création de ce fichier par l’IA du projet. L’accès au dépôt ne suffit pas. L’API n’autorise pas non plus une publication automatique de correctif : les propositions GitHub restent en brouillon, relues et approuvées par une personne, sans fusion automatique. L’examen d’un composant reste statique ; ce service n’exécute pas le code soumis.
Questions fréquentes
Passer à l’action
Cet article vous a-t-il aidé ?