Utilisation du traitement synchrone sync-processing-introduction
Forms as a Cloud Service - Les API de communications vous permettent de créer, assembler et diffuser des communications personnalisées et orientées sur la marque, telles que des correspondances commerciales, des documents, des récapitulatifs, des lettres de traitement des demandes, des avis de prestations, des lettres de traitement des demandes, des factures mensuelles et des kits de bienvenue. Vous pouvez utiliser les API de communication 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.
Forms as a Cloud Service - Communications fournit des API à la demande et par lots (API asynchrones) pour 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 batch-operations
Une opération synchrone est un processus de génération de documents de manière linéaire. Ces API sont classées comme API à client unique et API à plusieurs clients :
API à client unique
- API de génération de documents
- API de manipulation de documents
Authentifier une API à client unique
Les opérations des API à client unique prennent en charge deux types d’authentification :
-
Authentification de base : l’authentification de base est un schéma d’authentification simple intégré au protocole HTTP. Le client envoie des requêtes HTTP avec l’en-tête Autorisation qui contient le mot Base suivi d’un espace et d’une chaîne codée en base64 - nom d’utilisateur : mot de passe. Par exemple, pour autoriser en tant qu’administrateur / admin, le client envoie Base [chaîne codée en base64 - nom d’utilisateur] : [chaîne codée en base64 - mot de passe].
-
Authentification basée sur les jetons : l’authentification basée sur les jetons utilise un jeton d’accès (jeton d’authentification du porteur) pour envoyer des requêtes à Experience Manager as a Cloud Service. AEM Forms as a Cloud Service fournit des API pour récupérer en toute sécurité le jeton d’accès. Pour récupérer et utiliser le jeton afin d’authentifier une requête :
- Récupérer les informations d’identification Experience Manager as a Cloud Service à partir de Developer Console.
- Installer les informations d’identification Experience Manager as a Cloud Service dans votre environnement. (Serveur d’applications, serveur web ou autres serveurs non AEM) configurés pour envoyer des requêtes au service cloud (passer des appels).
- Générez un jeton JWT et échangez-le avec les API Adobe IMS pour un jeton d’accès.
- Exécutez l’API Experience Manager avec le jeton d’accès servant de jeton d’authentification du porteur.
- Définissez les autorisations appropriées pour l’utilisateur du compte technique dans l’environnement Experience Manager.
note note NOTE Adobe recommande d’utiliser l’authentification basée sur les jetons sur un environnement de production.
(Uniquement pour les API de génération de documents) Configuration des ressources et des autorisations
Pour utiliser les API synchrones, les éléments suivants sont requis :
- Utilisateurs ou utilisatrices disposant des privilèges d’administration Experience Manager
- Chargez les modèles et d’autres ressources vers votre instance Experience Manager Forms Cloud Service.
(Uniquement pour les API de génération de documents) Chargez des modèles et d’autres ressources vers votre instance 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 :
- Ouvrez votre instance Experience Manager.
- Accédez à Formulaires > Formulaires et documents
- Cliquez sur Créer > Dossier et créez un dossier. Ouvrez le dossier.
- 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 sur les API fournit également un fichier de définition de l’API au format .yaml. Vous pouvez télécharger le fichier .yaml et le télécharger dans Postman pour vérifier les fonctionnalités des API.