API Batch

Dernière mise à jour : 2024-01-29
  • Créé pour :
  • Intermediate
    Developer

Vous pouvez utiliser l’API Batch pour générer plusieurs communications interactives à partir d’un modèle. Le modèle consiste en une communication interactive sans données. L’API Batch combine des données avec un modèle pour créer une communication interactive. L’API est utile pour la production en masse de communications interactives. Par exemple, les factures de téléphone ou les relevés de cartes de crédit pour plusieurs clients.

En savoir plus sur l’API Batch Generation.

Cet article fournit des exemples de ressources pour générer des documents de communication interactive à l’aide de l’API Batch.

Génération par lots à l’aide du dossier de contrôle

Si vous exécutez AEM Forms sur un système d’exploitation autre que Windows, procédez comme suit :

  1. Ouvrez le dossier de contrôle.
  2. Sélectionnez BatchAPIWatchedFolder et cliquez sur Modifier.
  3. Modifiez le chemin d’accès en fonction de votre système d’exploitation.

Chemin.

  • Téléchargez et procédez à l’extraction du contenu du fichier zip. Le fichier zip renferme un dossier nommé jsonfile, qui contient le fichier beneficiaries.json. Ce fichier contient les données pour générer3 documents.

  • Déposez le dossier jsonfile dans le dossier d’entrée du dossier de contrôle.

  • Une fois le dossier sélectionné pour traitement, vérifiez le dossier de résultats du dossier de contrôle. Il doit contenir 3 fichiers PDF générés.

Génération pat lots à l’aide de requêtes REST

Vous pouvez appeler l’API Batch par le biais de requêtes REST. Vous pouvez exposer les points d’entrée REST pour que d’autres applications appellent l’API pour générer des documents.
Les exemples de ressources fournis exposent le point d’entrée REST pour générer des documents de communication interactive. Le servlet accepte les paramètres suivants :

  • fileName : emplacement du fichier de données sur le système de fichiers.
  • templatePath : chemin d’accès au modèle de communication interactive.
  • saveLocation : emplacement d’enregistrement des documents générés dans le système de fichiers.
  • channelType : impression, web ou les deux.
  • recordId : chemin JSON vers l’élément permettant de définir le nom d’une communication interactive.

La copie d’écran suivante montre les paramètres et les valeurs.
Exemple de requête.

Déployer des exemples de ressources sur votre serveur

Sur cette page