Synchrone verwerking gebruiken sync-processing-introduction
Met Forms as a Cloud Service - Communicatie-API's kunt u merkgeoriënteerde en gepersonaliseerde communicatie maken, samenstellen en leveren, zoals zakelijke correspondentie, documenten, instructies, aanvraagverwerkingsbrieven, aankondigingen van voordelen, aanvraagverwerkingsbrieven, maandelijkse facturen en welkomstkits. U kunt Communicatie APIs gebruiken om een malplaatje (XFA of PDF) met klantengegevens te combineren om documenten in PDF, PS, PCL, DPL, IPL, en ZPL formaten te produceren.
Overweeg een scenario waar u één of meerdere malplaatjes en veelvoudige verslagen van de gegevens van XML voor elke malplaatje hebt. U kunt communicatie-API's gebruiken om een afdrukdocument te genereren voor elke record. Het resultaat is een niet-interactief PDF-document. In een niet-interactief PDF-document kunnen gebruikers geen gegevens invoeren in de desbetreffende velden.
Forms as a Cloud Service - Communications biedt op aanvraag API's (asynchrone API's) voor het genereren van geplande documenten:
-
Synchrone API's zijn geschikt voor gebruik op aanvraag, met lage latentie en het genereren van documenten met één record. Deze API's zijn geschikter voor gebruiksgevallen die zijn gebaseerd op handelingen van gebruikers. Het genereren van een document bijvoorbeeld nadat een gebruiker een formulier heeft ingevuld.
-
Batch-API's (Asynchrone API's) zijn geschikt voor geplande toepassingen waarbij meerdere documenten met hoge doorvoer worden gegenereerd. Met deze API's worden documenten batchgewijs gegenereerd. Zo worden telefoonrekeningen, creditcardafschriften en uitkeringsafschriften elke maand gegenereerd.
Synchrone bewerkingen gebruiken batch-operations
Een synchrone bewerking is een proces waarbij documenten lineair worden gegenereerd. Deze API's worden geclassificeerd als API's voor één gebruiker en API's voor meerdere gebruikers:
API's voor één gebruiker
- API's voor het genereren van documenten
- Documentmanipulatie-API's
Verifieer enig-huurder API
API-bewerkingen van één gebruiker ondersteunen twee verificatietypen:
-
Basisauthentificatie: De basisauthentificatie is een eenvoudige authentificatieregeling die in het protocol van HTTP wordt gebouwd. De client verzendt HTTP-aanvragen met de machtigingsheader die het woord Basic bevat, gevolgd door een spatie en een base64-coded tekenreeks username:password. Bijvoorbeeld, om als admin/admin toe te staan verzendt de cliënt Basis [ base64-gecodeerde koordgebruikersbenaming ]: [ base64-gecodeerde koordwachtwoord ].
-
op token-gebaseerde authentificatie: Op token-gebaseerde authentificatie gebruikt een toegangstoken (het teken van de authentificatie van de Drager) om verzoeken aan Experience Manager as a Cloud Service te maken. AEM Forms as a Cloud Service verstrekt APIs om het toegangstoken veilig terug te winnen. Om het teken terug te winnen en te gebruiken om een verzoek voor authentiek te verklaren:
- wint as a Cloud Service credentie van de Experience Manager van Developer Consoleterug.
- installeer as a Cloud Service credentie van de Experience Manager op uw milieu. (De Server van de Toepassing, de Server van het Web, of andere niet-AEM servers) die worden gevormd om verzoeken naar (maken vraag) de wolkendienst te verzenden.
- produceer een teken JWT en ruilde het met Adobe IMS APIs voor een toegangstoken.
- Voer de Experience Manager-API met het toegangstoken uit als een token voor Dragerverificatie.
- plaats aangewezen toestemmingen voor de technische rekeningsgebruiker in het milieu van de Experience Manager.
note note NOTE Adobe raadt aan tokengebaseerde verificatie op een productieomgeving te gebruiken.
(Alleen voor API's voor documentgeneratie) Elementen en machtigingen configureren
Voor het gebruik van synchrone API's is het volgende vereist:
- Gebruikers met beheerdersrechten voor Experience Managers
- Sjablonen en andere elementen uploaden naar uw Experience Manager Forms Cloud Service-exemplaar
(Alleen voor API's voor documentgeneratie) Sjablonen en andere elementen uploaden naar uw Experience Manager-instantie
Een organisatie heeft doorgaans meerdere sjablonen. Bijvoorbeeld, één malplaatje elk voor creditcardverklaringen, voordelenverklaringen, en claimtoepassingen. Upload al dergelijke XDP en PDF malplaatjes aan uw instantie van de Experience Manager. Een sjabloon uploaden:
- Open een Experience Manager-instantie.
- Ga naar Forms > Forms en Documenten
- Klik op Maken > Map en maak een map. Open de map.
- Klik op Maken > Bestand uploaden en upload de sjablonen.
Een API aanroepen
De API verwijzingsdocumentatieverstrekt gedetailleerde informatie over alle parameters, authentificatiemethodes, en diverse diensten die door APIs worden verleend. De API-naslagdocumentatie biedt ook een API-definitiebestand in de indeling .yaml. U kunt het .yaml dossier downloaden en het uploaden aan Postmanom functionaliteit van APIs te controleren.