Référence de l’API REST ABSign : Guide des points de terminaison v2, de l’authentification et de l’intégration

Introduction à l’API ABSign v2

L’API REST v2 d’ABSign est l’interface de programmation officielle permettant d’intégrer des capacités de signature électronique de niveau entreprise dans vos systèmes d’entreprise, vos plateformes de trading et vos flux de gestion de documents. Construite sur les principes REST avec des charges utiles de requêtes et de réponses JSON, l’API se connecte de manière transparente à n’importe quelle pile technologique capable d’effectuer des appels HTTPS — des applications Python et Node.js aux services Java Spring Boot, en passant par les systèmes PHP Laravel et les applications .NET Core. Le point de terminaison de base pour tous les appels d’API v2 est https://www.abroadsign.com/api/v2/, qui remplace l’ancien point de terminaison v1 et introduit une sécurité améliorée, une couverture étendue des événements de webhook et une limitation de débit améliorée pour les intégrations d’entreprise à grand volume.

Des organisations dans plus de 180 pays s’appuient sur l’API ABSign pour automatiser les flux de signature de documents qui couvrent les contrats d’expédition de fret, les lettres de crédit de financement commercial, les déclarations en douane, les accords de chaîne d’approvisionnement multipartites et les documents d’approvisionnement d’entreprise. La version v2 introduit la prise en charge native des opérations de documents en masse, la fusion avancée de modèles, l’ancrage d’horodatage blockchain et des fonctionnalités de collaboration en temps réel qui permettent des cérémonies multi-signataires simultanées à partir de n’importe quel navigateur ou appareil mobile sans obliger les participants à installer un logiciel spécialisé ou à créer des comptes ABSign. Que vous soyez une startup créant votre premier flux d’intégration de clients ou une entreprise remplaçant entièrement une infrastructure contractuelle sur papier, l’API ABSign fournit les éléments de base pour une signature numérique entièrement automatisée et conforme à la loi à l’échelle mondiale.

Configuration de l’authentification et de la sécurité

La sécurisation de l’accès aux API est primordiale lors du traitement des signatures numériques juridiquement contraignantes. L’API ABSign v2 utilise une authentification basée sur une clé API combinée au cryptage de transport TLS 1.3, garantissant que chaque demande et réponse est cryptée en transit et insensible aux interceptions ou aux attaques de l’homme du milieu. Toutes les clés API sont générées à partir du tableau de bord ABSign sous Paramètres, avec des étendues d’autorisation granulaires qui suivent le principe du moindre privilège : chaque intégration reçoit exactement les autorisations dont elle a besoin, pas plus. Les clés ne sont jamais transmises dans les URL, uniquement dans les en-têtes HTTP, et vos systèmes doivent les stocker dans des variables d’environnement ou des plateformes de gestion de secrets dédiées telles qu’AWS Secrets Manager, HashiCorp Vault ou Azure Key Vault plutôt que de les intégrer dans des référentiels de code source ou des fichiers de configuration confiés aux systèmes de contrôle de version.

• En-tête du jeton du porteur : Chaque requête API doit inclure le Authorization: Bearer YOUR_API_KEY en-tête. Ne codez jamais en dur les clés API dans le code source de l’application ; utilisez des variables d’environnement ou des systèmes de gestion de secrets pour injecter des informations d’identification au moment de l’exécution.
• Application de TLS 1.3 : Toutes les connexions API doivent utiliser TLS 1.3. Les connexions tentant d’utiliser des versions TLS plus anciennes seront rejetées avec une réponse 400 Bad Request. Cela garantit que le contenu du document et les données de signature ne sont jamais exposés sur des canaux non cryptés.
• Portées des autorisations : Les clés API sont limitées à des opérations spécifiques : documents.read, documents.write, templates.read, templates.write, signers.manage, webhooks.admin et Organization.read. Attribuez uniquement les étendues requises pour chaque cas d’utilisation d’intégration afin de limiter le rayon d’explosion si une clé est compromise.
• Politique de rotation des clés : Mettez en œuvre une rotation automatisée des clés selon un calendrier de 90 jours. Le tableau de bord ABSign prend en charge la rotation des clés sans temps d’arrêt grâce au concept de clés primaires et secondaires, vous permettant de transférer les informations d’identification sans perturber les flux de travail de signature en vol.
• Liste d’autorisation IP : Les comptes d’entreprise peuvent restreindre l’accès aux API à des adresses IP ou à des plages CIDR spécifiques. Activez la liste blanche d’adresses IP à partir de la page Paramètres de sécurité pour les intégrations de serveur à serveur où les adresses IP appelantes sont connues et stables.

“La mise en œuvre de TLS 1.3 et de la portée des clés API a réduit à zéro les résultats de notre audit de sécurité. L’API ABSign a été conçue en tenant compte des exigences de sécurité de l’entreprise – cela s’est montré dans chaque détail du processus d’intégration.”

— Responsable de la sécurité de l’information, société mondiale de négoce de matières premières

Référence du point de terminaison de l’API principale

L’API v2 organise les fonctionnalités autour de points de terminaison orientés ressources qui correspondent naturellement aux entités d’un flux de travail de signature numérique : documents, modèles, signataires, signatures, webhooks et organisations. Chaque ressource prend en charge les opérations CRUD standard ainsi que les actions spécifiques à la ressource, telles que l’envoi de documents à signer, le rappel des signataires en attente ou le téléchargement de packages de documents terminés avec des signatures intégrées et des certificats d’intégrité cryptographique. Le tableau suivant fournit la référence complète du groupe de points de terminaison pour un développement d’intégration rapide.

Groupe de points de terminaison	Chemin de base	Opérations clés	Cas d’utilisation courant
Documents	/documents	Créer, lire, répertorier, mettre à jour, télécharger, archiver, supprimer	Initier la signature, récupérer les documents complétés
Modèles	/templates	Créer, lire, mettre à jour, supprimer, cloner, lister	Flux de travail documentaires standardisés
Signataires	/signers	Inviter, renvoyer l’invitation, annuler, vérifier l’identité	Gestion des parties signataires
Signature	/signatures	Appliquer, vérifier, vérifier l’état, récupérer la piste d’audit	Compléter et valider les signatures
Webhooks	/webhooks	Créer, lister, supprimer, tester, activer/désactiver	Notifications d’événements en temps réel
Organisations	/organizations	Lecture, mise à jour, paramètres, membres de l’équipe	Configuration d’administration et de conformité
Journaux d’audit	/audit-logs	Liste, Filtrer, Exporter, Télécharger PDF	Rapports de conformité et criminalistique
Opérations groupées	/bulk	Créer un lot, statut, annuler un lot	Traitement de documents volumineux

Modèle d’intégration du cycle de vie des documents

Le modèle d’intégration d’API le plus courant suit le cycle de vie du document, depuis sa création jusqu’à son archivage, en passant par la collecte des signatures. Ce flux de travail de bout en bout montre comment vos systèmes interagissent avec l’API ABSign à chaque étape, permettant des processus de signature entièrement automatisés sans intervention manuelle ni surcharge administrative. Comprendre ce cycle de vie est essentiel pour créer des intégrations fiables qui gèrent les scénarios de panne avec élégance et maintiennent la cohérence des données sur les systèmes distribués.

Étape 1 : Création de documents et remplissage de modèles

Commencez par créer un document soit à partir d’un modèle préconfiguré, soit à partir de contenu HTML ou PDF brut soumis directement à l’API. Pour une création basée sur un modèle, transmettez les valeurs des variables du modèle dans le corps de la demande afin de personnaliser le contenu du document pour chaque occasion de signature spécifique tout en préservant la cohérence de la marque et la standardisation des clauses juridiques. L’API répond immédiatement avec un ID de document que votre système stocke pour toutes les opérations ultérieures sur ce document. La création de documents prend en charge le mode batch, dans lequel vous pouvez soumettre jusqu’à 500 documents dans un seul appel API pour les files d’attente de traitement qui doivent lancer des dizaines ou des centaines de workflows de signature simultanément pendant les périodes de pointe des échanges.

• Utiliser POST /documents avec template_id et template_data pour créer à partir d’un modèle ou soumettre content_html ou content_pdf_base64 pour le contenu brut.
• Définissez le signing_sequence à sequential pour une signature multipartite ordonnée ou parallel lorsque toutes les parties peuvent signer simultanément pour minimiser le temps d’attente.
• Spécifier expiry_days pour contrôler la durée pendant laquelle l’invitation à signer reste active avant que le document n’expire automatiquement et ne nécessite un renouvellement.
• Activer block_download_until_completed pour empêcher un accès prématuré au document alors que toute signature requise est toujours en attente.

Étape 2 : Configuration des signataires et répartition du flux de travail

Après avoir créé un document, ajoutez les signataires requis en spécifiant leurs adresses e-mail, leurs noms d’affichage et leur position dans la séquence de signature. Pour les intégrations nécessitant une assurance d’identité améliorée, telles que les transactions de financement commercial de grande valeur ou les documents d’import-export réglementés, activez le identity_verification_required drapeau pour exiger une vérification biométrique ou d’identité gouvernementale avant que la signature ne soit acceptée. Envoyez le document à tous les signataires avec un seul appel API, et la plateforme ABSign génère automatiquement des invitations par courrier électronique au format professionnel avec des liens de document personnalisés, des avis d’expiration et des instructions de signature claires dans la langue préférée du destinataire.

• Ajouter des signataires via POST /documents/{document_id}/signers avec e-mail, nom et rôle (signer, witness, ou 抄送 pour cc).
• Configurer reminder_schedule pour envoyer automatiquement des e-mails de rappel à intervalles de 24 heures et 72 heures aux signataires qui n’ont pas encore agi.
• Ensemble redirect_url_after_signed pour guider les signataires vers une page de complétion personnalisée dans votre système une fois la signature terminée.
• Activer signer_authentication exigeant une vérification par e-mail OTP ou SMS comme couche supplémentaire de confirmation de l’identité du signataire.

Étape 3 : Achèvement piloté par Webhook et traitement en aval

Le système de webhook ABSign envoie des notifications d’événements en temps réel à votre point de terminaison HTTPS configuré chaque fois qu’un signataire agit ou que l’état du cycle de vie du document change. Plutôt que d’interroger l’API à plusieurs reprises pour vérifier l’état du document (ce qui consomme votre quota de limite de débit et ajoute de la latence), configurez les webhooks pour recevoir des notifications push qui déclenchent automatiquement les processus en aval. Dès réception du document.completed En cas d’événement, votre système récupère l’ensemble des documents complétés, y compris le PDF signé, le certificat de hachage cryptographique, l’ancre d’horodatage de la blockchain et le document de piste d’audit complet qui sert de preuve principale dans les litiges juridiques ou les audits de conformité.

---

Référence sur les événements Webhook et les notifications en temps réel

Les webhooks sont l’épine dorsale des architectures d’intégration automatisées. L’API ABSign v2 prend en charge une couverture complète des événements tout au long du cycle de vie du document, permettant à vos systèmes de répondre immédiatement lorsque des changements d’état se produisent plutôt que de compter sur des intervalles d’interrogation qui gaspillent le quota de l’API et introduisent une latence inutile dans vos flux de travail. Chaque livraison de webhook comprend une charge utile JSON avec des données spécifiques à l’événement et un en-tête de signature HMAC-SHA256 que votre point de terminaison doit vérifier avant de traiter la notification afin d’éviter que des événements usurpés ne déclenchent des actions non autorisées dans vos systèmes.

Type d’événement	Condition de déclenchement	Champs de charge utile clés	Réponse d’intégration
document.created	Nouveau document ajouté à la plateforme	document_id, titre, créé_à, créé_par	Inscrivez-vous dans le système de suivi interne
document.sent	Document envoyé aux signataires	document_id, signataires[], expires_at, sujet	Mettre à jour l’état du tableau de bord du workflow
signer.viewed	Le signataire ouvre le lien du document	document_id, signer_id, visualisé_at, adresse_ip	Enregistrer l’engagement et déclencher la minuterie
signer.completed	Le signataire soumet sa signature	document_id, signer_id, signé_at, signature_hash	Vérifier l’achèvement, avertir en aval
document.completed	Toutes les signatures requises obtenues	document_id,complete_at,download_url,audit_trail_url	Déclencher la prochaine étape du flux de travail
document.expired	Délai de signature dépassé	document_id, expiré_at, signataires_pendant[]	Initier le renouvellement ou alerter l’équipe opérationnelle
document.declined	Le signataire refuse explicitement de signer	document_id, signer_id, refusé_at, raison	Alerter les opérations et escalader
document Voided	Document annulé par le créateur	document_id, voided_by, voided_at, raison	Fermer les dossiers internes et avertir

Limites de débit, quotas et optimisation des performances

L’API ABSign v2 applique des limites de débit pour garantir la stabilité de la plate-forme et une allocation équitable des ressources entre tous les consommateurs d’API. Les comptes de niveau standard sont limités à 1 000 requêtes par minute et par clé API, tandis que les comptes d’entreprise reçoivent des limites élevées négociées en fonction des exigences d’intégration documentées et des volumes de transactions attendus. L’état de la limite de débit est communiqué dans chaque réponse API via le X-RateLimit-Remaining et X-RateLimit-Reset en-têtes de réponse, permettant à votre intégration de mettre en œuvre une limitation proactive plutôt que d’attendre 429 réponses pour déclencher un comportement d’attente. Pour les opérations par lots de gros volumes traitant des milliers de documents, utilisez le /bulk des points de terminaison spécialement conçus pour un débit de masse avec des quotas par minute plus élevés et une surcharge par document réduite.

• Moniteur X-RateLimit-Remaining en-tête sur chaque réponse et suspendre les demandes à l’approche de zéro pour éviter de recevoir des réponses 429 Too Many Requests qui interrompent le traitement pour la fenêtre de réinitialisation.
• Utilisez le Retry-After valeur d’en-tête pour attendre la durée exacte avant de reprendre les requêtes plutôt que d’implémenter des intervalles de sommeil arbitraires qui peuvent être trop courts ou inutilement longs.
• Pour le traitement de documents en masse, préférez POST /bulk points finaux sur individu POST /documents appels : les opérations en masse offrent une amélioration du débit jusqu’à 10 fois pour les flux de travail à volume élevé.
• Implémentez une interruption exponentielle avec instabilité pour toutes les logiques de nouvelle tentative afin de gérer les erreurs passagères côté serveur sans surcharger la plate-forme pendant les périodes de récupération.
• Utiliser Conditional Requests avec If-Modified-Since ou ETag en-têtes lors de la récupération du statut du document pour éviter les transferts de données inutiles et réduire la latence des contrôles de statut.

“Nous traitons plus de 50 000 documents de fret par mois via l’API ABSign. Le point de terminaison des opérations en masse combiné à une gestion appropriée des webhooks signifie que l’ensemble de notre flux de travail de signature s’exécute avec une latence inférieure à la minute – sans aucune intervention après l’appel initial de l’API. “

— Ingénieur principal de plate-forme, réseau mondial de transitaire

Packages SDK officiels et démarrage rapide

ABSign maintient des packages SDK officiels pour les langages et frameworks de programmation les plus largement adoptés, chacun fournissant des structures de données en langage natif, une logique de nouvelle tentative automatique avec une interruption exponentielle pour les échecs transitoires, des définitions de type complètes pour la sécurité au moment de la compilation et des paramètres client HTTP préconfigurés qui sont conformes aux exigences de sécurité de l’API. Les packages SDK sont open source et disponibles sur GitHub, où les contributions de la communauté pour des langues supplémentaires sont les bienvenues et examinées par l’équipe d’ingénierie d’ABSign. Tous les SDK officiels sont versionnés en phase avec l’API pour garantir que les signatures et le comportement des méthodes du SDK restent cohérents avec les points de terminaison REST sous-jacents.

• SDK Python : Installer via pip install abroadsign-api. Prise en charge complète asynchrone/attente pour les applications Python modernes, avec des aides à l’intégration automatiques pour les systèmes de tâches en arrière-plan basés sur Django, FastAPI et Celery. Conseils de type complets et prise en charge de la saisie semi-automatique de l’IDE inclus.
• SDK Node.js/TypeScript : Installer via npm install abroadsign-api. Package TypeScript entièrement typé avec des définitions de type complètes pour tous les objets de requête et de réponse. Inclut la prise en charge native du middleware pour Express.js, les routes API Next.js et les fonctions sans serveur sur AWS Lambda et Vercel.
• SDK Java/Spring Boot : Coordonnées Maven disponibles sur Maven Central. Compatible avec Spring Boot 2.x et 3.x, avec prise en charge de la configuration automatique et documentation Javadoc complète pour les équipes de développement Java d’entreprise.
• SDK PHP : Package conforme PSR compatible avec les applications Laravel, Symfony et PHP 8.1+ autonomes. Inclut le fournisseur de services Laravel pour une configuration transparente de l’injection de dépendances via le conteneur de services Laravel.
• SDK .NET/C# : Compatibilité .NET Standard 2.0 prenant en charge .NET Framework, .NET Core et .NET 5+ sur Windows, Linux et macOS. Inclut l’intégration de l’injection de dépendances ASP.NET Core avec le modèle HttpClientFactory.

---

Premiers pas : votre première intégration d’API

Commencez votre intégration en accédant à l’environnement sandbox de l’API ABSign, qui fournit un miroir API entièrement fonctionnel avec des données de test isolées qui n’affectent pas les coffres-forts de documents de production ni ne sont prises en compte dans les quotas de production. Générez vos informations d’identification API sandbox à partir du tableau de bord sous Paramètres et commencez immédiatement à effectuer des appels API pour explorer la création de documents, la configuration des signataires et la livraison de webhooks dans un environnement sécurisé. Le bac à sable simule automatiquement les cérémonies de signature, afin que vous puissiez tester des flux de travail complets de bout en bout sans attendre que de véritables signataires humains agissent pendant les cycles de développement et d’assurance qualité. Notre portail de documentation interactif sur les API fournit un explorateur d’API en direct dans lequel vous pouvez exécuter des requêtes directement dans le navigateur, inspecter les charges utiles des requêtes et des réponses et générer des extraits de code prêts à l’emploi pour n’importe quel point de terminaison dans l’un des langages SDK pris en charge.

Pour des modèles d’intégration avancés, notamment le traitement par lots de gros volumes, les implémentations multi-locataires en marque blanche et les architectures de fiabilité des webhooks personnalisées, explorez notre Guide d’automatisation du flux de travail documentaire qui couvre l’optimisation des performances, les stratégies de gestion des erreurs et les meilleures pratiques de déploiement en entreprise. Notre équipe d’ingénierie d’intégration propose également des sessions gratuites de révision de l’architecture technique aux entreprises clientes afin de valider votre conception d’intégration avant de vous engager sur des volumes de trafic de production.

Prêt à construire votre intégration ? Visitez le portail de documentation API pour des références complètes sur les points de terminaison, des téléchargements de SDK et des exemples de code de travail. Pour toute question sur les exigences des API d’entreprise, l’architecture d’intégration personnalisée ou la mise à l’échelle de la production, contactez notre équipe d’intégration technique pour planifier une séance gratuite de révision de l’architecture avec l’un de nos ingénieurs API senior.