Tester une intégration API

Utiliser le guide intégrateur pour obtenir un jeton, préparer une demande et ouvrir son lien de signature.

En bref

Le Guide d’intégration API se trouve dans API & Développeurs, ainsi que dans la fenêtre qui affiche les identifiants de l’application. Il fournit l’URL de l’environnement, un exemple de terminal et la liste des opérations prises en charge.

Étapes détaillées

1. Terminez l’inscription et l’enrôlement de votre compte. Faites attribuer l’offre convenue à votre organisation.
2. Ouvrez API & Développeurs et créez votre application avec les droits nécessaires à l’intégration.
3. Conservez le Client ID et le Client secret dans votre gestionnaire de secrets. Le secret ne sera plus affiché après fermeture de la fenêtre.
4. Ouvrez le Guide d’intégration API. Reprenez l’URL de base indiquée pour cet environnement.
5. Préparez un PDF de test, une adresse email et un mobile de test sous votre contrôle. Renseignez les variables demandées par l’exemple, puis exécutez-le depuis votre environnement serveur ou votre terminal.
6. Ouvrez le lien obtenu pour réaliser la signature. Consultez ensuite l’état de la demande. La rubrique Récupérer les documents du guide indique comment télécharger chaque pièce après finalisation et traiter les réponses temporaires.

1. Consultez Récupérer les preuves dans le guide : l’état indique les exports disponibles. Conservez le PDF dès sa disponibilité, puis téléchargez de nouveau l’archive quand la preuve OTS est complétée.
2. Pour valider votre plateforme de bout en bout, rejouez le second script de la rubrique Recette complète du parcours client : deux documents, envoi, signature réelle, notifications, un PDF final par document, preuves, confirmation Bitcoin et reprise. Il produit un journal sans secret que vous pouvez joindre à une demande de support.

Règles métier et cas particuliers

• L’accès API, les niveaux de signature et les volumes disponibles dépendent de votre offre. Une offre gratuite ne donne pas automatiquement accès à l’API.
• L’exemple active une demande réelle et consomme les unités selon votre offre. Il utilise la compatibilité YouSign et la Signature Vérifiée.
• L’activation YouSign ne déclenche actuellement pas d’email d’invitation : l’intégration récupère le lien de signature et l’ouvre dans sa plateforme.
• Le secret reste côté serveur. Ne l’intégrez pas au code envoyé au navigateur et ne le partagez pas dans une demande de support.
• Les tableaux du guide indiquent les opérations prises en charge et les limites de compatibilité. En cas de refus de contrat ou de quota, corrigez la cause avant de rejouer l’appel.
• Une application ne peut pas consulter une demande appartenant à une autre organisation. Un lien de signature n’est fourni que pour une participation en attente, sur une demande activée et avec un lien encore valide.

• Le webhook de fin annonce des PDF finaux récupérables par API. Un email de fin en échec peut être repris sans bloquer ce téléchargement. La confirmation Bitcoin arrive séparément. La rubrique 8. Webhooks du guide explique comment s’abonner à cet événement propre à BizSign, puis récupérer l’OTS complété et l’archive avec le jeton applicatif.
• Les notifications sont reprises après un échec ou un arrêt du worker. Votre plateforme doit accepter les rediffusions du même événement et répondre avec un statut HTTP 2xx après prise en charge.
• Le statut terminé peut précéder la disponibilité du PDF. Si le téléchargement répond `409 DOCUMENT_NOT_READY`, attendez le délai `Retry-After` avant de réessayer. `DOCUMENT_FINALIZATION_FAILED` indique qu’une reprise est nécessaire.
• Chaque pièce principale fournit son propre PDF final ; les annexes restent leurs fichiers d’origine. Un fichier final manquant n’est pas remplacé par un original ou par un autre document.
• La confirmation Bitcoin est distincte de la finalisation des PDF et ne bloque pas leur récupération. La rubrique Récupérer les preuves fournit les routes du dossier PDF, du fichier OTS et de leur archive, avec le même jeton applicatif.

• Le ZIP inclut les jetons d’horodatage d’origine et la notice `README.txt`. Si un jeton est absent ou incohérent, l’API répond `409` avec `PROOF_ARCHIVE_INCOMPLETE` ; les exports PDF et OTS séparés restent disponibles.