API AEM Forms Communications - Présentation

Les API d’AEM Forms fournissent une suite complète d’API natives dans le cloud conçues pour aider les entreprises à automatiser les workflows de documents.

Les API d’AEM Forms sont structurées et accessibles via deux consoles principales :

  • Adobe Developer Console (ADC) - Adobe Developer Console est la passerelle vers les API, les événements, le runtime et App Builder d’Adobe.

  • AEM Developer Console - AEM Developer Console permet d’accéder aux détails, aux configurations, aux comptes techniques et aux informations d’identification de service au niveau de l’environnement, afin de prendre en charge les tâches opérationnelles et d’intégration.

Différentes API prennent en charge différentes ​ méthodes d’authentification ​.

Méthodes d’authentification

Les différentes API Forms utilisent différentes méthodes d’authentification en fonction de leur calendrier de publication :

Les API antérieures prenaient en charge l’authentification serveur à serveur basée sur JWT, qui est configurée et gérée via AEM Developer Console. Les API plus récentes utilisent l’authentification de serveur à serveur OAuth et sont configurées via Adobe Developer Console.

Présentation de la classification d’API

Toutes les API d’AEM Forms sont divisées en deux parties principales :

Détails
API de diffusion et d’exécution de formulaire adaptatif
API de communication
Objectif
Gérer les opérations de diffusion et d’exécution de formulaires adaptatifs
Génération et manipulation de documents
Cas d’utilisation
- Rendu du formulaire
- Préremplissage de données
- Envois de formulaires
- Gestion des brouillons
- Génération de PDF
- Fusion de documents
- Traitement par lots
- Opérations d’impression
Méthode d’autorisation
Prend en charge les méthodes d’authentification de serveur à serveur/utilisateur OAuth.
Prend en charge l’authentification de serveur à serveur, au format JWT ou OAuth, selon l’API. Une API ne peut pas prendre en charge les deux méthodes d’authentification.

API AEM Forms Communications

Les API Communications sont le principal point d’intérêt des opérations centrées sur les documents.

Le tableau ci-dessous répertorie toutes les API AEM Forms Communications ainsi que leurs méthodes d’authentification et modèles d’exécution pris en charge :

API de génération de documents

Point d’entrée de l’API
Description
Modèle d’exécution
Méthode d'authentification
/adobe/forms/batch/output/config
Crée une configuration de lot pour les traitements de génération de documents.
Asynchrone/par lot
​ JWT ​
/adobe/forms/batch/output/config/{configName}
Récupère les détails d’une configuration de lot spécifique.
Asynchrone/par lot
​ JWT ​
/adobe/forms/batch/output/config/configs
Renvoie une liste de toutes les configurations de lot disponibles.
Asynchrone/par lot
​ JWT ​
/adobe/forms/batch/output/config/{configName}/execution
Démarre une exécution de génération de sortie par lots à l’aide d’une configuration .
Asynchrone/par lot
​ JWT ​
/adobe/forms/batch/output/config/{configName}/execution/{executionId}
Récupère le statut d’exécution d’un traitement par lots.
Asynchrone/par lot
​ JWT ​
/adobe/forms/batch/output/config/{configName}/exécutions
Répertorie toutes les instances en cours d’exécution pour une configuration de lot spécifique.
Asynchrone/par lot
​ JWT ​
/adobe/forms/doc/v1/generatePDFOutput
Génère une sortie PDF de manière synchrone en fonction de modèles et de données.
Synchrone
​ JWT ​
/adobe/forms/doc/v1/generatePrintedOutput
Génère des formats de sortie prêts à l’impression (par exemple, PCL, PostScript).
Synchrone
​ JWT ​
/adobe/forms/doc/v1/generate/afp
Génère une sortie AFP pour l'impression de gros volumes.
Synchrone
​ JWT ​
/adobe/document/generate/pdfform
Rend un formulaire PDF (XFA/XDP) avec des données fusionnées.
Synchrone
Oauth
/adobe/document/generate/pdfform/jobs/{id}/status
Récupère le statut d’une tâche de génération de formulaire PDF.
Synchrone
Oauth
/adobe/document/generate/pdfform/jobs/{id}/result
Récupère la sortie/le résultat d’une tâche de formulaire PDF terminée.
Synchrone
Oauth

API de manipulation de documents

Point d’entrée de l’API
Description
Modèle d’exécution
Méthode d'authentification
/adobe/forms/assembler/ddx/invoke
Exécute les instructions DDX pour combiner, fractionner ou manipuler des fichiers PDF.
Synchrone
​ JWT ​
/adobe/forms/assembler/pdfa/convert
Convertit un document PDF au format PDF/A.
Synchrone
​ JWT ​
/adobe/forms/assembler/pdfa/validate
Valide si un PDF est conforme à la norme PDF/A
Synchrone
​ JWT ​

API de conversion de documents

Point d’entrée de l’API
Description
Modèle d’exécution
Méthode d'authentification
/adobe/document/convert/pdftoxdp
Convertit un formulaire PDF au format XDP.
Synchrone
Oauth

API d’extraction de documents

Point d’entrée de l’API
Description
Modèle d’exécution
Méthode d'authentification
/adobe/forms/doc/v1/extract/pdfproperties
Extrait les propriétés et les informations structurelles d’un PDF.
Synchrone
Oauth
/adobe/forms/doc/v1/extract/usagerights
Extrait les droits d’utilisation incorporés dans un PDF.
Synchrone
Oauth
/adobe/forms/doc/v1/extract/metadata
Extrait les métadonnées telles que le titre, l’auteur et les mots-clés.
Synchrone
Oauth
/adobe/forms/doc/v1/extract/data
Extrait les données de formulaire (XML/JSON) de PDF forms.
Synchrone
Oauth
/adobe/document/extract/security
Extrait les paramètres de sécurité tels que les autorisations et le chiffrement.
Synchrone
Oauth

API de transformation de documents

Point d’entrée de l’API
Description
Modèle d’exécution
Méthode d'authentification
/adobe/document/transform/metadata
Met à jour ou ajoute des métadonnées dans un document PDF.
Synchrone
Oauth
/adobe/document/field/signature/add
Ajoute un champ de signature numérique à un PDF.
Synchrone
Oauth
/adobe/document/field/signature/clear
Efface le contenu d’un champ de signature.
Synchrone
Oauth
/adobe/document/field/signature/remove
Supprime un champ de signature d’un PDF.
Synchrone
Oauth

API Document Assurance

Point d’entrée de l’API
Description
Modèle d’exécution
Méthode d'authentification
/adobe/document/assure/usagerights
Applique des droits d’utilisation à un PDF (par exemple, commentaire, remplissage, signature).
Synchrone
Oauth
/adobe/document/assure/encrypt
Chiffre un PDF avec mot de passe ou certificat de sécurité.
Synchrone
Oauth
/adobe/document/assure/decrypt
Déchiffre un document PDF sécurisé.
Synchrone
Oauth
/adobe/document/assure/sign
Signe numériquement un document PDF.
Synchrone
Oauth
/adobe/document/assure/certifie
Certifie un PDF avec un certificat numérique.
Synchrone
Oauth

Étapes connexes

Découvrez comment définir un environnement pour les API de communication Forms synchrones (à la demande) et asynchrones (par lots) :

API synchrones

API AEM Forms Communications - Synchrones

Découvrez comment configurer un environnement pour les API de communications Forms synchrones (à la demande) qui génèrent ou traitent des documents instantanément.

En savoir plus

API asynchrones

API AEM Forms Communications - Asynchrones (lot)

Découvrez comment configurer un environnement pour les API de communications Forms asynchrones (par lots) qui génèrent ou traitent plusieurs documents de manière planifiée.

En savoir plus

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab