Utilisation du traitement synchrone

La fonctionnalité Communications vous permet de créer, d’assembler et de diffuser des communications personnalisées et axées sur la marque. Il peut notamment s’agir de correspondances d’entreprise, de documents, de relevés, de courriers de traitement des réclamations, d’avis de prestations, de factures mensuelles et de kits de bienvenue. Vous pouvez utiliser les API Communications pour combiner un modèle (XFA ou PDF) avec des données client afin de générer des documents aux formats PDF, PS, PCL, DPL, IPL et ZPL.

Supposons que vous ayez un ou plusieurs modèles et plusieurs enregistrements de données XML pour chaque modèle. Vous pouvez utiliser les API Communications pour générer un document d’impression pour chaque enregistrement. Le résultat est un document PDF non interactif. Dans ce type de document, les utilisateurs n’ont pas la possibilité de saisir des données dans les champs.

La fonctionnalité Communications fournit des API pour la génération de documents planifiés et à la demande. Vous pouvez utiliser des API synchrones pour les API à la demande et Batch (API asynchrones) concernant la génération de documents planifiés :

  • Les API synchrones sont adaptées aux cas d’utilisation de génération de documents à la demande, à faible latence et pour un enregistrement unique. Ces API sont plus adaptées aux cas d’utilisation basés sur une action de l’utilisateur. Il peut s’agir, par exemple, de la génération d’un document après qu’un utilisateur a rempli un formulaire.

  • Les API Batch (API asynchrones) conviennent pour la génération planifiée à débit élevé de documents multiples. Ces API génèrent des documents par lots. Il peut s’agir, par exemple, de factures de téléphone, de relevés de carte de crédit et de relevés de prestations générés tous les mois.

Utilisation des opérations synchrones

Une opération synchrone est un processus de génération de documents de manière linéaire. Des API distinctes sont disponibles pour :

  • Génère un document PDF à partir d’un modèle et y fusionne les données.
  • Générez un document PostScript (PS), PCL (Printer Command Language), Zebra Printing Language) à partir d’un fichier XDP ou d’un document de PDF.
  • Assemblage de documents PDF
  • Désassemblage de documents PDF
  • Convertir un document en document compatible avec le PDF/A
  • Validation d’un document conforme au PDF/A

Authentification d’un appel API

Les opérations synchrones prennent en charge deux types d’authentification :

(Uniquement pour les API Document Generation) Configuration des ressources et des autorisations

Pour utiliser des API synchrones, les conditions suivantes sont requises :

  • Modèles PDF ou XDP
  • Données à fusionner avec des modèles
  • Utilisateurs disposant des privilèges d’administrateur Experience Manager
  • Chargez les modèles et d’autres ressources vers votre instance Experience Manager Forms Cloud Service.

(Uniquement pour les API Document Generation) Téléchargez des modèles et d’autres ressources vers votre instance de Experience Manager.

Une entreprise possède généralement différents modèles. Par exemple, un modèle pour les relevés de carte de crédit, les relevés de prestations et les réclamations. Chargez tous ces modèles XDP et PDF vers votre instance Experience Manager. Pour charger un modèle :

  1. Ouvrez votre instance Experience Manager.
  2. Accédez à Formulaires > Formulaires et documents
  3. Cliquez sur Créer > Dossier et créez un dossier. Ouvrez le dossier.
  4. Cliquez sur Créer > Téléchargement de fichier et chargez les modèles.

Appel d’une API

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 fournit également un fichier de définition de l’API au format .yaml . Vous pouvez télécharger le fichier .yaml et le charger dans Postman pour vérifier les fonctionnalités des API.

REMARQUE

Seuls les membres du groupe des utilisateurs de formulaires peuvent accéder aux API Communications.

Sur cette page