API de communication as a Cloud Service d’AEM Forms frequently-asked-questions
La fonctionnalité Communications vous permet de créer des documents personnalisés, normalisés et approuvés par la marque, tels que des correspondances commerciales, des récapitulatifs, des lettres de traitement des demandes, des avis de prestations, des factures mensuelles ou des kits de bienvenue.
Cette fonctionnalité fournit des API pour générer et manipuler les documents. Vous pouvez générer ou manipuler un document à la demande ou créer une tâche par lots pour générer plusieurs documents à des intervalles définis. Les API Communications fournissent les éléments suivants :
-
Des fonctionnalités simplifiées de génération de documentation par lots et à la demande
-
La possibilité de combiner, réorganiser et valider des documents PDF à la demande
-
Des API HTTP pour une intégration plus facile aux systèmes existants Des API distinctes pour les opérations à la demande (faible latence) et par lots (opérations à débit élevé) sont incluses.
-
un accès sécurisé aux données. Les API de communication se connectent aux données et n’y accèdent que depuis des référentiels de données désignés par les client(e)s, ce qui rend les communications hautement sécurisées.
Génération de documents
Les API de génération de documents de communication permettent de combiner un modèle (XFA ou PDF) avec des données client (XML) pour générer des documents aux formats PDF et d’impression tels que PS, PCL, DPL, IPL et ZPL. Ces API utilisent des modèles PDF et XFA avec des données XML pour générer un seul document à la demande ou plusieurs documents à l’aide d’un traitement par lots.
En règle générale, vous créez un modèle à l’aide de Designer et utilisez les API Communications pour fusionner les données avec le modèle. Votre application peut envoyer le document de sortie à une imprimante réseau, à une imprimante locale ou à un système de stockage pour archivage. Les workflows standard et personnalisés se présentent comme suit :
En fonction du cas d’utilisation, vous pouvez également rendre ces documents disponibles au téléchargement via votre site Web ou un serveur de stockage.
Voici quelques exemples d’API de génération de documents :
Création de documents PDF create-pdf-documents
Vous pouvez utiliser les API de génération de documents pour créer un document PDF basé sur un design de formulaire et des données de formulaire XML. La sortie est un document PDF non interactif. En d’autres termes, les utilisateurs ne peuvent pas saisir ni modifier les données de formulaire. Un processus de base consiste à fusionner les données de formulaire XML avec un design de formulaire pour créer un document PDF. L’illustration suivante présente la fusion d’un design de formulaire et de données de formulaire XML pour produire un document PDF.
Schéma : workflow standard de création d’un document PDF
Créer un document PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL) create-PS-PCL-ZPL-documents
Vous pouvez utiliser des API de génération de document pour créer un document PostScript (PS), PCL (Printer Command Language) et Zebra Printing Language (ZPL) basé sur une conception de formulaire XDP ou un document de PDF. Ces API permettent de fusionner un design de formulaire avec des données de formulaire pour générer un document. Vous pouvez enregistrer le document dans un fichier et développer un processus personnalisé pour l’envoyer à une imprimante.
Traitement des données par lots pour créer plusieurs documents processing-batch-data-to-create-multiple-documents
Vous pouvez utiliser des API de génération de documents pour créer des documents distincts pour chaque enregistrement au sein d’une source de données par lots XML. Vous pouvez générer des documents en mode massif et asynchrone. Vous pouvez configurer différents paramètres pour la conversion, puis lancer le traitement par lots.
Manipulation de documents
Les API de manipulation de documents de communication (Document Transformation) permettent de combiner et de réorganiser des documents de PDF. En règle générale, vous créez un DDX et l’envoyez aux API de manipulation de document pour assembler ou réorganiser un document. Le document DDX décrit comment utiliser les documents source pour générer un ensemble de documents désirés. La documentation de référence DDX fournit des informations détaillées sur toutes les opérations prises en charge. Voici quelques exemples de manipulation de documents :
Assemblage de documents PDF
Vous pouvez utiliser les API de manipulation de documents pour assembler deux documents PDF ou XDP ou plus dans un seul document PDF ou portfolio PDF. Vous trouverez ci-dessous quelques-unes des méthodes d’assemblage de documents PDF :
- Assemblage d’un document PDF unique
- Création d’un portfolio PDF
- Assemblage de documents chiffrés
- Assemblage de documents à l’aide de la numérotation Bates
- Aplatissement et assemblage de documents
Schéma : assemblage d’un document PDF unique à partir de plusieurs documents PDF
Désassemblage de documents PDF
Vous pouvez utiliser les API de manipulation de documents pour désassembler un document PDF. Ces API peuvent extraire des pages du document source ou diviser un document source en fonction de signets. Cette tâche est particulièrement utile lorsque le document PDF d’origine a été créé à partir de plusieurs documents séparés, par exemple un ensemble d’instructions.
- Extraire des pages d’un document source
- Division d’un document source en fonction de signets
Schéma : division d’un document source en plusieurs documents en fonction de signets
Extraction de document
La capacité d’extraction de documents s’inscrit dans le cadre du Programme des premiers adopteurs. Vous pouvez écrire à aem-forms-ea@adobe.com à partir de votre ID de courrier électronique officiel pour rejoindre le programme des premiers adopteurs et demander l’accès à la fonctionnalité.
Le service Extraction de documents vous permet d’obtenir les propriétés d’un document de PDF, telles que ses droits d’utilisation, ses propriétés de PDF et ses métadonnées. Les fonctionnalités d’extraction de document sont les suivantes :
- Obtient les propriétés d’un document de PDF, telles que si le PDF comporte des pièces jointes, des commentaires, sa version Acrobat, etc.
- Extrayez les droits d’utilisation activés dans un document de PDF. Les utilisateurs récupèrent les droits d’utilisation activés ou désactivés dans un document de PDF pour l’extensibilité Adobe Acrobat Reader.
- Pour obtenir les informations de métadonnées présentes dans un document de PDF, les métadonnées sont des informations sur le document (qui se distinguent du contenu du document, telles que le texte et les graphiques). La plateforme de métadonnées extensibles (XMP) Adobe est une norme de gestion des métadonnées de document. Le service XMP Utilities peut récupérer XMP métadonnées de documents PDF et exporter des métadonnées dans des documents PDF.
La variable Documentation de référence sur les API fournit des informations détaillées sur tous les paramètres, les méthodes d’authentification et les services fournis par les API. La documentation de référence de l’API est également disponible au format .yaml. Vous pouvez télécharger le fichier .yaml et le charger dans Postman pour vérifier les fonctionnalités des API.
Conversion de document
Conversion et validation de documents conformes à la norme PDF/A
Les API de conversion de document de communication aident à convertir un document de PDF en PDF/A. Vous pouvez utiliser les API pour convertir un document de PDF en document compatible avec le PDF/A, ainsi que pour déterminer si un document de PDF est compatible avec le PDF/A. PDF/A est un format d’archivage destiné à la conservation à long terme du contenu du document. Les polices sont incorporées dans le document et le fichier est décompressé. Par conséquent, un document PDF/A est généralement plus volumineux qu’un document PDF standard. De plus, un document PDF/A ne contient aucune donnée audio et vidéo.
Convertir le PDF en XDP convert-pdf-to-xdp
La fonctionnalité Convertir le PDF en XDP est inscrite au Programme des premiers adopteurs. Vous pouvez écrire à aem-forms-ea@adobe.com à partir de votre ID de courrier électronique officiel pour rejoindre le programme des premiers adopteurs et demander l’accès à la fonctionnalité.
Convertit un document de PDF en fichier XDP. Pour qu’un document de PDF soit converti en fichier XDP, le document de PDF doit contenir un flux XFA dans le dictionnaire.
Document Assurance doc-assurance
Le service DocAssurance comprend les API Signature et Encryption :
API de signature
Les API Signature permettent à votre entreprise de garantir la sécurité et la confidentialité des documents Adobe PDF qu’elle diffuse et reçoit. Les fonctions de sécurité sont appliquées au document lui-même, le document reste sécurisé et contrôlé pendant tout son cycle de vie. Le document reste sécurisé au-delà du pare-feu, lorsqu’il est téléchargé hors ligne et lorsqu’il est renvoyé à votre entreprise. Vous pouvez accomplir les tâches suivantes à l’aide des API de signature :
- Ajoutez un champ de signature visible à un document de PDF.
- Ajoutez un champ de signature invisible à un document de PDF.
- Signez le champ de signature spécifié dans un document de PDF.
- Certifier un document de PDF
API de chiffrement
Les API Encryption vous permettent de chiffrer et de déchiffrer des documents. Lorsqu’un document est chiffré, son contenu devient illisible. Une personne autorisée peut déchiffrer le document pour pouvoir accéder à son contenu. Si un document PDF est chiffré avec un mot de passe, l’utilisateur doit spécifier le mot de passe d’ouverture pour pouvoir visualiser le document dans Adobe Reader ou Adobe Acrobat.
Vous pouvez accomplir ces tâches à l’aide des API Encryption :
- Chiffrez un document de PDF avec un mot de passe.
- Supprimez le chiffrement avec mot de passe d’un document de PDF.
- Récupérez le type de sécurité appliqué à un document de PDF.
- Renvoyer le type de sécurité appliqué à un document PDF.
Les API de signature et les API de chiffrement sont API synchrones.
Utilitaires de document doc-utility
Les utilitaires de document avec les API synchrones vous aident à convertir des documents entre les formats de fichiers PDF et XDP. Appliquez des droits d’utilisation à un document et extrayez les droits d’utilisation activés à partir d’un document. Requête d’informations sur un document PDF. Vous trouverez ci-dessous des informations détaillées sur les API de droits d’utilisation :
API de droits d’utilisation (extension de Reader)
La fonctionnalité Droits d’utilisation (extension de Reader) figure dans le Programme des Adopteurs Anticipés. Vous pouvez écrire à aem-forms-ea@adobe.com à partir de votre ID de courrier électronique officiel pour rejoindre le programme des premiers adopteurs et demander l’accès à la fonctionnalité.
La fonctionnalité Droits d’utilisation permet à votre entreprise de partager facilement des documents de PDF interactifs en étendant la fonctionnalité d’Adobe Reader avec des droits d’utilisation supplémentaires. Le service fonctionne avec Adobe Reader 7.0 ou version ultérieure et ajoute des droits d’utilisation à un document PDF. Cette action active des fonctionnalités qui ne sont généralement pas disponibles lors de l’ouverture d’un document de PDF à l’aide d’Adobe Reader, comme l’ajout de commentaires à un document, le remplissage de formulaires et l’enregistrement du document.
Lorsque les droits d’utilisation appropriés sont ajoutés aux documents PDF, les destinataires peuvent effectuer les activités suivantes depuis Adobe Reader :
- Remplissez des documents et des formulaires PDF en ligne ou hors ligne, ce qui permet aux destinataires d’enregistrer des copies localement pour leurs enregistrements tout en préservant les informations ajoutées.
- Enregistrez les documents du PDF sur un disque dur local afin de conserver le document d’origine ainsi que tous les commentaires, données ou pièces jointes supplémentaires.
- Joindre des fichiers et des clips multimédia à des documents PDF.
- Signez, certifiez et authentifiez des documents PDF en appliquant des signatures numériques à l’aide des technologies PKI (Public Key Infrastructure, infrastructure à clé publique) standard.
- Envoyez les documents PDF complétés ou annotés par voie électronique.
- Utilisez des documents et des formulaires PDF comme interface de développement intuitive pour les bases de données internes et les services Web.
- Partage de documents PDF pour que les réviseurs puissent ajouter des commentaires à l’aide d’outils intuitifs d’insertion de commentaires et d’annotations, tels que notes autocollantes, tampons, texte surligné et texte barré. Les mêmes fonctions sont disponibles dans Acrobat.
- Prise en charge du décodage Forms à code à barres.
Ces fonctionnalités de droits d’utilisation spéciaux sont automatiquement activées lorsqu’un document de PDF dont les droits sont activés est ouvert dans Adobe Reader. Lorsque l’utilisateur a fini de travailler avec un document dont les droits sont activés, ces fonctions sont à nouveau désactivées dans Adobe Reader. Elles restent désactivées jusqu’à ce que l’utilisateur ou l’utilisatrice reçoive un autre document PDF dont les droits sont activés.
Activation ou désactivation des droits d’utilisation
Les différentes fonctionnalités de droits d’utilisation pour étendre les services de Reader de PDF sont les suivantes :
-
Décodage des codes à barres: pour décoder les codes à barres dans le document du PDF.
-
Commentaires: mise en commentaire hors ligne sur le document du PDF.
-
Commentaires en ligne: mise en commentaire en ligne sur le document du PDF.
-
Signature numérique: pour ajouter des signatures numériques à un document de PDF.
-
Champs de formulaire dynamique: pour ajouter des champs de formulaire à un document de PDF.
-
Pages de formulaire dynamique: pour ajouter des pages de formulaire à un document de PDF.
-
Fichiers incorporés: pour incorporer des fichiers dans un document de PDF.
-
Importation de données de formulaire: pour importer des données de formulaire dans un document de PDF.
-
Exportation des données de formulaire: pour importer des données de formulaire dans un document de PDF.
-
Remplissage du formulaire: pour remplir les champs de formulaire dans un document de PDF.
-
Forms en ligne: pour accéder à un service Web ou à une base de données à partir d’un document de PDF.
-
Submit Standalone: pour envoyer des données de formulaire hors ligne à partir d’un document de PDF.
Autres fonctionnalités
- Message: message affiché dans Adobe Acrobat Reader lors de l’ouverture d’un document de PDF avec un ou plusieurs droits d’utilisation appliqués.
- Déverrouiller le mot de passe: mot de passe requis pour l’ouverture d’un document de PDF chiffré. En règle générale, il s’agit du mot de passe d’ouverture du document, mais si le document du PDF est en outre protégé par un mot de passe d’accès, vous pouvez l’utiliser pour l’ouvrir.
La documentation de référence sur les API fournit des informations détaillées sur tous les paramètres, les méthodes d’authentification et les différents services fournis par les API. La documentation de référence de l’API est également disponible au format .yaml. Vous pouvez télécharger le fichier .yaml et le charger dans Postman pour vérifier les fonctionnalités des API.
Types d’API de communication types
Communications fournit des API HTTP pour la génération de documents à la demande et par lots :
-
Les API synchrones sont adaptées aux scénarios de génération de documents à la demande, à faible latence et à enregistrement unique. Ces API sont plus adaptées aux cas d’utilisation basés sur une action de l’utilisateur. Par exemple, la génération d’un document une fois qu’un utilisateur a rempli un formulaire.
-
Les API par lot (API asynchrones) sont adaptées aux scénarios de génération de documents multiples, à débit élevé et planifiés. Ces API génèrent des documents par lots. Par exemple, des factures de téléphone, des relevés de carte de crédit et des relevés d’avantages sont générés tous les mois.
Intégration
La fonctionnalité Communications est disponible sous la forme d’un module autonome et d’un module complémentaire pour les utilisateurs de Forms as a Cloud Service. Vous pouvez contacter l’équipe des ventes d’Adobe ou votre représentant d’Adobe pour demander l’accès. Adobe autorise l’accès de votre entreprise et fournit les privilèges requis à la personne désignée comme administrateur au sein de votre entreprise. L’administrateur peut accorder l’accès aux développeurs (utilisateurs) as a Cloud Service Forms de votre entreprise pour utiliser les API.
Après l’intégration, pour activer la fonctionnalité de communications pour votre environnement as a Cloud Service Forms :
-
Connectez-vous à Cloud Manager et ouvrez votre instance AEM Forms as a Cloud Service.
-
Ouvrez l’option Modifier le programme, accédez à l’onglet Solutions et modules complémentaires, puis sélectionnez l’option Formulaires - Communications.
Si vous avez déjà activé l’option Forms - Inscription numérique, sélectionnez l’option Forms - Module complémentaire Communications.
-
Cliquez sur Mettre à jour.
-
Exécutez le pipeline de build. Une fois que le pipeline de build a réussi, les API Communications sont activées pour votre environnement.
# Allow Forms Doc Generation requests/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }