Aller au contenu principal

Accès au pipeline par API

Un pipeline peut être invoqué directement par un système externe, sans passer par l'interface web, via une clé API.

Générer une clé​

Depuis Manager → Paramètres → Clés API (rôle api_key_manager ou hérité) :

  1. Générez une clé — elle est préfixée hnk_, reste consultable à tout moment (contrairement à un jeton « affiché une seule fois »), et peut avoir une date d'expiration ou ne jamais expirer.
  2. Assignez-lui un ou plusieurs pipelines précis : la clé ne peut lancer des analyses que sur les pipelines qui lui sont explicitement assignés (toute autre tentative échoue).

Chaque clé est rattachée en interne à un utilisateur de service dédié, pour que les jobs lancés via l'API restent attribuables et traçables comme n'importe quel autre job.

Appels disponibles​

Avec l'en-tête Authorization: Bearer hnk_... :

  • POST /api/jobs — soumet un document à analyser (upload multipart : fichier, identifiant du pipeline, documents supports éventuels).
  • POST /api/jobs/from-url — soumet un document via un lien (Google Docs/Slides partagé) plutôt qu'un upload direct.
  • GET /api/jobs/{id} — consulte le statut d'une analyse en cours.
  • GET /api/jobs/{id}/download — télécharge le document annoté une fois l'analyse terminée.
  • POST /api/jobs/{id}/cancel — annule une analyse en cours.

L'éditeur de pipeline propose un panneau « API » qui génère automatiquement du code prêt à copier (Python, JavaScript, PHP, VB.NET) illustrant ces appels avec l'identifiant du pipeline courant déjà renseigné.