API publique Hubflow

Version : v1 · Base URL : https://<votre-domaine>/api/v1

Version résumée. La documentation complète (champs, exemples de requêtes et de réponses) est à restaurer à partir du fichier api.html d'origine.

1. Présentation

L'API publique permet à vos applications de piloter les dépôts : créer une demande de pièces, inviter les personnes concernées, suivre l'avancement et récupérer les fichiers reçus.

Modèle de données

Un dépôt (deposit) est une demande de pièces. Il contient des slots (les pièces demandées : « carte d'identité », « RIB »…) et des destinataires (directory, les personnes à qui l'on demande ces pièces). Chaque fichier déposé par un destinataire dans un slot est un upload. Un type de slot (slot_type) est un modèle réutilisable de slot, avec ses règles de vérification et ses contrôles.

Versionnement

Le numéro de version est dans l'URL. Les ajouts de champs ou d'endpoints se font sans changement de version : votre intégration doit ignorer les champs inconnus. Un retrait ou un changement de sens donnera lieu à une v2.

2. Démarrage rapide

1. Créez une clé API depuis les réglages de votre espace. La valeur complète n'est affichée qu'à la création : copiez-la immédiatement.
2. Appelez l'API avec cette clé dans l'en-tête d'authentification.

3. Authentification

Toutes les routes exigent une clé API. Une clé donne accès à un seul espace, avec les droits de l'utilisateur qui l'a créée. Hubflow ne conserve que le hash SHA-256 de la clé. Une clé révoquée est refusée immédiatement (API_KEY_REVOKED).

Environnements : live et test. Il n'existe pas encore de bac à sable isolé : une clé test lit et écrit les mêmes données qu'une clé live.

4. Ressources

• Compte : GET /account
• Dépôts : créer, lister, lire, modifier
• Slots : les pièces d'un dépôt
• Destinataires : inviter, relancer
• Fichiers reçus : GET /deposits/{public_id}/uploads, puis GET /uploads/{id}/download
• Listes de contacts
• Types de slot : modèles de pièces et leurs règles (rules, par exemple extension:eq:pdf|and|size:lt:5000000)

5. Limites connues

Pas de bac à sable isolé, pas encore de portée par clé (lecture seule…). Les routes antérieures à la v1 restent actives mais ne doivent pas servir aux nouvelles intégrations.