Créer un document avec l'API PandaDoc
Crée un document à partir d'un modèle (template_uuid) ou d'un PDF public (url et name). Il reste en document.uploaded quelques secondes puis passe en document.draft. Rien n'est envoyé : appelez Send document quand Get document status affiche document.draft.
- Identifiant
- pandadoc_create_document
L'appel
POST https://connect.reportei.com/api/tools/pandadoc_create_document/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"recipients": []
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| template_uuid | string | Non | Id of the template, from List templates. Send it or url, never both. |
| url | string | Non | Public HTTPS URL of a PDF to build the document from, instead of a template. Requires name. The signers fill the fields marked in the PDF with PandaDoc field tags, or its own form fields when parse_form_fields is true. |
| parse_form_fields | boolean | Non | Only with url: true when the PDF has form fields, false when it uses PandaDoc field tags. |
| name | string | Non | Name of the document. Required with url. |
| recipients | array | Oui | People who receive the document. Each one needs email or phone. |
| tokens | array | Non | Values of the template variables, as listed by Get template. |
| fields | object | Non | Values of the fields by field name, as listed by Get template. Each value is an object with value (text, number, boolean or an RFC 3339 date) and, optionally, the role it belongs to, like {"Company": {"value": "Acme"}}. Signature fields cannot be filled. |
| texts | array | Non | Content for the text blocks of the template, by block name, as listed by Get template. |
| pricing_tables | array | Non | Content for the pricing tables of the template, by table name, as listed by Get template. Send every product of a table, because the table is rebuilt from what you send. |
| folder_uuid | string | Non | Folder for the document, with the uuid from List document folders. Omit it for the root folder. |
| metadata | object | Non | Your own key-value data stored with the document, like the id of the deal in your system. |
| tags | array | Non | Tags of the document. |
Connexions possibles
Votre client connecte son compte PandaDoc une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/pandadoc, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/pandadoc_create_document. Il devient la définition de tool de votre agent sans conversion.
Autres tools PandaDoc
- Lister les documentsGETListe les documents du workspace avec id, name, status et dates, 50 par page par défaut. Demandez la page suivante avec page ; une page avec moins de résultats que count est la dernière.
- Obtenir un documentGETRenvoie les détails d'un document : status, destinataires avec leur id, has_completed et shared_link, champs, tokens, tarifs, textes, metadata et tags. Fonctionne une fois que le document a quitté le statut document.uploaded.
- Obtenir le statut d'un documentGETRenvoie l'id, le name et le status d'un document. Après Create document, le statut reste document.uploaded quelques secondes ; attendez document.draft avant de le modifier ou de l'envoyer.
- Mettre à jour un documentPATCHMet à jour un document au statut document.draft : name, destinataires, variables, champs, blocs de texte, tableaux de prix, metadata et tags. Pour un document déjà envoyé, appelez d'abord Move document to draft.
- Remettre un document en brouillonPOSTRemet un document envoyé ou terminé en document.draft pour que Update document puisse le modifier. Les champs de signature et d'initiales sont effacés, les destinataires ne sont pas prévenus et le document doit être renvoyé.
- Envoyer un documentPOSTEnvoie un document au statut document.draft à ses destinataires, par email sauf si silent vaut true, et le passe en document.sent, ce qui verrouille sa structure. Avec une clé sandbox, les destinataires doivent partager le domaine email de l'expéditeur.
- Envoyer une relance de documentPOSTEnvoie maintenant une relance aux destinataires qui doivent encore terminer un document envoyé. Le résultat indique, par destinataire, si chaque relance est partie ; avec un ordre de signature, seul le signataire courant peut être relancé.
- Supprimer un documentDELETESupprime un document. Avec forever false il va dans la Corbeille, d'où il peut être restauré ; sans forever, PandaDoc le supprime définitivement.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
