La Réception (intake) vous permet d'ajouter à votre site un point de dépôt sécurisé : vos utilisateurs choisissent des fichiers depuis leur navigateur, ceux-ci sont chiffrés avant d'être envoyés, et vous récupérez les dépôts côté serveur. Le déroulé est en trois temps : vous ouvrez un point de réception avec votre clé secrète, vous intégrez la clé publiable dans votre page web, puis vous listez les documents reçus depuis votre serveur. Cette recette suit ces étapes une par une, avec des exemples prêts à coller.
Étape 1 - Ouvrir un point de réception
Appelez POST /v1/intakes avec votre clé secrète (scope intake:write). Les champs utiles : name (obligatoire), allowed_origins pour restreindre les domaines autorisés à déposer, reference_required si chaque dépôt doit porter une référence, et metadata_policy. La réponse contient l'identifiant de l'intake et, montrée une seule fois, la clé publiable cip_.
/v1/intakesCrée un point de réception et renvoie sa clé publiable (cip_), affichée une seule fois.Étape 2 - Intégrer le dépôt dans votre page
Côté navigateur, le plus rapide est le widget no-code : un script à charger, un conteneur vide, et un appel à mountIntake. Vos utilisateurs glissent leurs fichiers, qui sont chiffrés dans le navigateur avant l'envoi. Le paramètre reference rattache chaque dépôt à votre identifiant métier (une référence opaque, jamais une identité réelle), et metadata permet d'ajouter des champs d'enveloppe en clair.
Si vous préférez votre propre interface (votre bouton, votre champ de fichiers), pilotez l'intake directement avec la classe Coffrify.Intake. La méthode upload accepte une FileList ou un tableau de File, et un callback onProgress vous renseigne sur l'avancement.
Étape 3 - Récupérer les dépôts côté serveur
Depuis votre serveur, listez les documents reçus avec GET /v1/intakes/{id}/documents et votre clé secrète (scope intake:read). Vous pouvez filtrer par votre référence métier avec ?reference=… pour ne récupérer que les dépôts d'un dossier donné, et par ?status=…. La liste est paginée par curseur : passez next_cursor dans cursor tant que has_more vaut true.
/v1/intakes/{id}/documentsListe les documents reçus (métadonnées). Filtres reference et status, pagination par curseur.Chaque entrée décrit un dépôt. Voici les champs renvoyés :
| Champ | Description |
|---|---|
| id | Identifiant du document reçu. |
| intake_id | Identifiant du point de réception. |
| client_reference | Votre référence opaque, telle que fournie au dépôt. |
| metadata | Métadonnées d'enveloppe (en clair) attachées au dépôt. |
| status | État du dépôt (par exemple reçu, en cours). |
| files_count | Nombre de fichiers dans le dépôt. |
| total_size_bytes | Taille totale du dépôt, en octets. |
| encrypted | Indique si le contenu est chiffré de bout en bout. |
| source | Origine du dépôt (api, widget…). |
| created_at | Date de réception. |
Vous avez maintenant une boucle complète : un intake créé par API, un dépôt intégré à votre page via la clé publiable, et la récupération des dépôts côté serveur via la clé secrète. Pour réagir en temps réel plutôt que d'interroger périodiquement, créez un webhook (POST /v1/webhooks) et abonnez-vous aux évènements request.created, request.submitted et request.completed : Coffrify notifie votre serveur dès qu'un dépôt arrive.