Documentation API

API BizSign pour intégrateurs

Intégrez la signature électronique blockchain dans vos applications via notre couche de compatibilité DocuSign et YouSign : si votre système parle déjà l'une de ces deux API, il parle déjà à BizSign.

1. Authentification 2. Scopes 3. Compat DocuSign 4. Compat YouSign 5. Webhooks

1. Authentification (OAuth2)

L'API utilise le flux OAuth2 client_credentials (RFC 6749 §4.4). Vos identifiants client_id / client_secret vous sont fournis par l'équipe BizSign : faites une demande d'accès ici.

# 1. Obtenir un token d'accès (valide 1h)
curl -X POST https://bizsign.fr/api/compat/oauth/token \
  -d "grant_type=client_credentials" \
  -d "client_id=VOTRE_CLIENT_ID" \
  -d "client_secret=VOTRE_CLIENT_SECRET" \
  -d "scope=signature:read signature:write"

# Réponse
{
  "access_token": "…",
  "token_type": "bearer",
  "expires_in": 3600,
  "scope": "signature:read signature:write"
}

Passez ensuite le token dans l'en-tête Authorization: Bearer <access_token> de chaque requête.

Limites de débit (rate limiting)

Endpoint /api/compat/oauth/token : maximum 10 requêtes/minute par adresse IP.
Appels API authentifiés : quota par client (60 requêtes/minute par défaut, ajustable par l'équipe BizSign selon votre contrat).
En cas de dépassement, l'API répond 429 Too Many Requests avec un en-tête Retry-After (secondes à attendre avant de réessayer).

2. Scopes

Scope	Autorise
`signature:read`	Lecture des demandes de signature / enveloppes
`signature:write`	Création, envoi, annulation des demandes
`documents:read`	Téléchargement des documents (signés inclus)
`documents:write`	Ajout / remplacement de documents
`webhooks:read`	Liste des souscriptions webhooks
`webhooks:write`	Création / suppression de souscriptions webhooks

3. API compatible DocuSign (v2.1)

Base : /api/compat/docusign/v2.1/accounts/{accountId} — sémantique DocuSign eSignature REST API v2.1.

Méthode	Endpoint	Description
POST	/envelopes	Créer une enveloppe (status "sent" = envoi immédiat, supporte eventNotification)
GET	/envelopes	Lister les enveloppes
GET	/envelopes/{id}	Détail d'une enveloppe
PUT	/envelopes/{id}	Envoyer ("sent") ou annuler ("voided") une enveloppe
GET	/envelopes/{id}/documents	Lister les documents
GET	/envelopes/{id}/documents/{docId}	Télécharger un document
GET	/envelopes/{id}/recipients	Lister les destinataires
POST	/envelopes/{id}/recipients	Ajouter des destinataires
POST	/envelopes/{id}/recipients/{rid}/tabs	Placer des champs de signature (tabs)
POST	/envelopes/{id}/views/recipient	Générer l'URL de signature embarquée

4. API compatible YouSign (v3)

Base : /api/compat/yousign/v3 — sémantique YouSign API v3.

Méthode	Endpoint	Description
POST	/signature_requests	Créer une demande de signature
GET	/signature_requests/{id}	Détail d'une demande
POST	/signature_requests/{id}/documents	Ajouter un document (base64)
POST	/signature_requests/{id}/signers	Ajouter un signataire
POST	/signature_requests/{id}/activate	Activer (envoyer) la demande
POST	/signature_requests/{id}/cancel	Annuler la demande
GET	/signature_requests/{id}/documents/{docId}/download	Télécharger un document
POST	/webhooks	Créer une souscription webhook
GET	/webhooks	Lister les souscriptions actives
DELETE	/webhooks/{id}	Supprimer une souscription

5. Webhooks

Recevez les événements du cycle de vie en temps réel. Deux modes de souscription :

Compte (style YouSign) : POST /api/compat/yousign/v3/webhooks — tous les événements de votre compte.
Enveloppe (style DocuSign) : champ eventNotification à la création de l'enveloppe.

Événements YouSign

signature_request.activated
signature_request.done
signature_request.declined
signature_request.canceled
signer.done
signer.declined

Événements DocuSign

envelopeEvents : sent, completed, declined, voided
recipientEvents : Completed, Declined

Les payloads signés avec un secret (souscriptions YouSign) portent l'en-tête X-Yousign-Signature-256: sha256=<HMAC-SHA256 du corps>. En cas d'échec (réponse non 2xx), la livraison est retentée avec backoff exponentiel (1 min, 5 min, 30 min, 2 h, 12 h).

# Souscrire aux événements (style YouSign)
curl -X POST https://bizsign.fr/api/compat/yousign/v3/webhooks \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://votre-app.example.com/callbacks/bizsign",
    "events": ["signature_request.done", "signer.done"],
    "secret": "votre-secret-hmac"
  }'

Référence interactive (Swagger)

Le schéma OpenAPI complet de la plateforme est disponible pour explorer les requêtes et réponses en détail.

Ouvrir Swagger UI

Prêt à intégrer ?

Demandez vos identifiants Sandbox : notre équipe technique vous contacte sous 24h.

Demander un accès API