Développeurs

Construisez avec les mêmes éléments que nous.

Une API REST pour créer, envoyer et suivre des dossiers, placement des champs compris : un envoi n’a jamais besoin de passer par notre éditeur.

Sur cette page

Le propriétaire d’un espace Pro, Équipe ou Entreprise crée un jeton dans Paramètres, Intégrations. La référence complète se trouve sur la page Documentation API, et une description OpenAPI 3.1 lisible par machine à /api/v1/openapi.json, ce qui suffit à la plupart des générateurs pour créer un client typé. Nous ne publions pas de SDK écrit à la main.

Principaux points d’accès

MéthodeCheminCe qu’il fait
POST/api/v1/envelopesCréer un dossier à partir de PDF téléversés, avec les champs
POST/api/v1/envelopes/{id}/sendEnvoyer un brouillon de dossier pour signature
GET/api/v1/envelopesLister les dossiers, avec filtres et pagination
GET/api/v1/envelopes/{id}Lire l’état du dossier et la progression des destinataires
POST/api/v1/envelopes/from-refsCréer un dossier à partir de références de documents
POST/api/v1/envelopes/{id}/remindEnvoyer un rappel aux signataires en attente
POST/api/v1/envelopes/{id}/voidAnnuler un dossier
GET/api/v1/envelopes/{id}/finalTélécharger le PDF terminé (aplati)
GET/api/v1/envelopes/{id}/certificateTélécharger le certificat d’audit
GET/api/v1/envelopes/{id}/recipientsLister les destinataires et leur progression
PATCH/api/v1/envelopes/{id}/recipients/{rid}Corriger un destinataire, même après l’envoi
POST/api/v1/envelopes/{id}/recipients/{rid}/remindEnvoyer un rappel à un destinataire précis
GET/api/v1/templatesLister les modèles de l’espace
POST/api/v1/templates/{id}/envelopesCréer un dossier à partir d’un modèle (et l’envoyer au besoin)
GET/api/v1/openapi.jsonDescription OpenAPI 3.1 de tout ce qui précède

Requête authentifiée

curl
curl https://vg-sign.com/api/v1/envelopes/{id} \
  -H "Authorization: Bearer vgs_live_…"

Signature des webhooks

Chaque livraison porte une empreinte HMAC-SHA256 du corps brut. Vérifiez-la avec le secret de votre abonnement avant de vous fier au contenu. Une livraison est tentée jusqu’à 3 fois (nouvelles tentatives après environ 1 et 5 minutes), puis marquée comme échouée. L’identifiant de livraison reste le même d’une tentative à l’autre. Servez-vous-en pour éliminer les doublons.

en-têtes
X-VG-Signature: sha256=4c2a9bd3…71ff
X-VG-Delivery-Id: 8f4a2c1e-9b3d-4f02-a71c-2d5e6b8c0a19

Serveur MCP

Claude, Claude Code et Cursor peuvent lister les dossiers, en créer un à partir d’un modèle, l’envoyer et télécharger le PDF signé. C’est un serveur stdio qui utilise la même API REST et le même jeton d’espace; il ne reçoit aucun droit supplémentaire. Il n’existe pas de jetons limités par portée : l’assistant peut donc faire tout ce que le jeton permet. Envisagez un espace distinct pour lui. Le remplacement du jeton prend effet immédiatement et interrompt toute autre intégration qui utilise encore l’ancien : remplacez-le dès qu’il a pu être exposé.

télécharger et vérifier
curl -fsSLO https://vg-sign.com/mcp/server.mjs
curl -fsSL https://vg-sign.com/mcp/server.mjs.sha256 | sha256sum -c -
configuration mcp
{
  "mcpServers": {
    "vg-sign": {
      "command": "node",
      "args": ["/path/to/server.mjs"],
      "env": {
        "VG_SIGN_API_TOKEN": "vgs_live_…",
        "VG_SIGN_DOWNLOAD_DIR": "/path/to/a/downloads/folder"
      }
    }
  }
}

send_envelope, remind_envelope, void_envelope et create_envelope_from_template avec send: true agissent sur de vrais dossiers et envoient des courriels à de vraies personnes. C’est l’annulation qui défait un envoi; une annulation ne peut pas être défaite par un autre appel.

Signature intégrée

Placez la page de signature dans votre propre produit. Votre origine doit d’abord être autorisée, demandez-nous de l’ajouter, et le cadre transmet la progression à la fenêtre parente.

html
<script src="https://vg-sign.com/embed.js"></script>
<div id="vg-sign" data-token="RECIPIENT_TOKEN"></div>

VGSign.mount({ onSigned: e => …, onDeclined: e => … })

// Under the hood the frame posts { source: 'vg-sign', type, token } to
// the parent window when the signer reaches a terminal state.