Aller au contenu principal
Présentation de l'API

Trois endpoints de processus et deux sondes de santé.

Markdown

Human Plugin est servi en HTTP simple sur le port que vous configurez (8080 par défaut). L'URL de base est l'endroit où vous exposez le conteneur dans votre réseau, par exemple http://human-plugin.internal:8080.

MéthodeCheminObjectif
POST/v1/processesCréer un processus, avec l'un des flux
GET/v1/processes/{id}Obtenir un processus
GET/v1/processes/{id}/selfieObtenir le selfie
GET/health/liveLiveness. Voir Santé et supervision
GET/health/readyReadiness (ping de la base de données)

Il n'existe pas d'endpoint pour lister, supprimer ou rechercher des processus, ni de récepteur de webhook.

Règles valables pour chaque appel​

  • Aucun en-tête d'authentification. Human Plugin ne valide pas les appelants. Restreignez plutôt l'accès réseau : voir Réseau et sécurité.
  • JSON uniquement, avec des noms de champs en camelCase.
  • Les réponses sont Cache-Control: no-store.
  • Les erreurs utilisent une seule enveloppe, {"message": "INVALID_REQUEST", "details": []}. Voir Erreurs et nouvelles tentatives.
  • id est l'id de processus de Human Plugin. Conservez-le depuis la création : c'est ainsi que vous relirez le processus plus tard.

Séquence type​

Suite : Créer un processus.