AEM Forms as a Cloud Service Communication-API's communications-apis-overview
Beschikbaarheid van de Versie
- AEM 6.5: Overzicht van de Diensten van het Document van AEM
- AEM as a Cloud Service: Dit artikel
Inleiding
Via communicatie-API's in AEM Forms as a Cloud Service kunt u door uw merk goedgekeurde, gepersonaliseerde en gestandaardiseerde documenten maken voor uw zakelijke behoeften. Met deze krachtige API's kunt u documenten programmatisch genereren, manipuleren en beveiligen, op aanvraag of in batchprocessen op grote volumes.
Belangrijkste voordelen
- Gestroomlijnde documentgeneratie - creeer gepersonaliseerde documenten door malplaatjes met klantengegevens samen te voegen
- Krachtige documentmanipulatie - combineer, herschik, en bevestig de documenten van PDF programmatically
- Flexibele plaatsingsopties - Gebruik op bestelling APIs voor lage latentiebehoeften of batch-APIs voor high-productietaken
- Verbeterde veiligheid - pas digitale handtekeningen, certificatie, en encryptie toe om gevoelige documenten te beschermen
- Cloud-inheemse architectuur - hefboomwerking scalable, veilige wolkeninfrastructuur zonder onderhoudsoverheadkosten
Overzicht van API-mogelijkheden
Communicatie-API's bieden een uitgebreide set mogelijkheden voor documentverwerking die zijn ingedeeld in de volgende functionele gebieden:
De API verwijzingsdocumentatieverstrekt gedetailleerde informatie over alle parameters, authentificatiemethodes, en diverse diensten die door APIs worden verleend. De API-naslagdocumentatie is ook beschikbaar in de indeling .yaml. U kunt de .yaml downloaden en uploaden naar Postman om de functionaliteit van de API's te controleren.
Document genereren
Via API's voor het genereren van communicatiedocumenten kunt u een sjabloon (XFA of PDF) combineren met klantgegevens (XML) om documenten te genereren in PDF en de indeling Afdrukken, zoals de indelingen PS, PCL, DPL, IPL en ZPL. Deze APIs gebruikt PDF en de malplaatjes XFA met gegevens van XMLom één enkel document op bestelling of veelvoudige documenten te produceren die een partijbaan gebruiken.
Typisch, creeert u een malplaatje gebruikend Designeren gebruikt Mededelingen APIs om gegevens met het malplaatje samen te voegen. Uw toepassing kan het uitvoerdocument naar een netwerkprinter, een lokale printer of een opslagsysteem verzenden voor archivering. Een typisch uit de doos en de douanewerkschema's kijken als het volgende:
Afhankelijk van het gebruiksgeval kunt u deze documenten ook beschikbaar stellen voor downloaden via uw website of een opslagserver.
Belangrijke mogelijkheden voor het genereren van documenten
PDF-documenten maken create-pdf-documents
Met de API's voor het genereren van documenten kunt u een PDF-document maken dat is gebaseerd op een formulierontwerp en XML-formuliergegevens. De uitvoer is een niet-interactief PDF-document. Met andere woorden, gebruikers kunnen de formuliergegevens niet invoeren of wijzigen. Een basisworkflow is het samenvoegen van XML-formuliergegevens met een formulierontwerp om een PDF-document te maken. In de volgende afbeelding ziet u hoe een formulierontwerp en XML-formuliergegevens worden samengevoegd om een PDF-document te maken.
Afbeelding: Normale workflow voor het maken van een PDF-document
De API voor het genereren van documenten retourneert het gegenereerde PDF-document. U kunt de gegenereerde PDF's optioneel ook uploaden naar Azure Blob Storage.
Het uploaden van geproduceerde PDFs die de generatie API van het document aan het vermogen van de Opslag van Azure Blob gebruiken is onder Vroege Programma van de Aannemer. U kunt vanaf uw officiële e-mailadres naar aem-forms-ea@adobe.com schrijven om deel te nemen aan het programma voor vroege adoptie en toegang tot de functie te vragen.
PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL)-document maken create-PS-PCL-ZPL-documents
U kunt API's voor het genereren van documenten gebruiken om een PostScript-document (PS), een PCL-document (Printer Command Language) en een ZPL-document (Zebra Printing Language) te maken dat is gebaseerd op een XDP-formulierontwerp of PDF-document. Deze API's helpen u bij het samenvoegen van een formulierontwerp met formuliergegevens om een document te genereren. U kunt het document opslaan in een bestand en een aangepast proces ontwikkelen om het naar een printer te verzenden.
Batchgegevens verwerken om meerdere documenten te maken processing-batch-data-to-create-multiple-documents
Met API's voor het genereren van documenten kunt u afzonderlijke documenten maken voor elke record in een XML-batchgegevensbron. U kunt documenten bulksgewijs en asynchroon genereren. U kunt diverse parameters voor de omzetting vormen en dan het partijproces beginnen.
Documentmanipulatie
Met API's voor het manipuleren van communicatiedocumenten (Document Transformation) kunt u PDF-documenten combineren en opnieuw rangschikken. Doorgaans maakt u een DDX en verzendt u deze naar API's voor documentmanipulatie om een document samen te stellen of opnieuw te rangschikken. Het DDX- documentverstrekt instructies op hoe te om de brondocumenten te gebruiken om een reeks vereiste documenten te veroorzaken. De DDX-referentiedocumentatie biedt gedetailleerde informatie over alle ondersteunde bewerkingen.
Belangrijkste mogelijkheden voor documentmanipulatie
PDF-documenten samenstellen
U kunt de API's voor documentmanipulatie gebruiken om twee of meer PDF- of XDP-documenten samen te voegen tot één PDF-document of PDF Portfolio. Hier volgen enkele voorbeelden van manieren waarop u PDF-documenten kunt samenstellen:
- Een eenvoudig PDF-document samenstellen
- Een PDF Portfolio maken
- Gecodeerde documenten samenstellen
- Documenten samenstellen met Bates-nummering
- Documenten samenvoegen en samenvoegen
Afbeelding: Een eenvoudig PDF-document samenstellen op basis van meerdere PDF-documenten
PDF-documenten demonteren
U kunt de API's voor documentmanipulatie gebruiken om een PDF-document te demonteren. De API's kunnen pagina's uitnemen uit het brondocument of een brondocument splitsen op basis van bladwijzers. Doorgaans is deze taak handig als het PDF-document oorspronkelijk is gemaakt op basis van veel afzonderlijke documenten, zoals een verzameling instructies.
- Pagina's uit een brondocument extraheren
- Een brondocument splitsen op basis van bladwijzers
Afbeelding: Een brondocument dat is gebaseerd op bladwijzers, opsplitsen in meerdere documenten
Document uitnemen
De functie voor het uitnemen van documenten valt onder het programma voor vroegtijdige adoptie. U kunt vanaf uw officiële e-mailadres naar aem-forms-ea@adobe.com schrijven om deel te nemen aan het programma voor vroege adoptie en toegang tot de functie te vragen.
Met de service Documentextractie kunt u de eigenschappen van een PDF-document ophalen, zoals gebruiksrechten, PDF-eigenschappen en metagegevens. De mogelijkheden voor het uitnemen van documenten zijn:
- Hiermee worden de eigenschappen van een PDF-document opgehaald, bijvoorbeeld als de PDF bijlagen, opmerkingen, de Acrobat-versie en nog veel meer bevat.
- Haal de gebruiksrechten uit die in een PDF-document zijn ingeschakeld, gebruikers halen de gebruiksrechten op die voor Adobe Acrobat Reader-uitbreidbaarheid zijn in- of uitgeschakeld.
- Haal de metagegevens op die aanwezig zijn in een PDF-document. De metagegevens zijn informatie over het document (zoals die wordt onderscheiden van de inhoud van het document, zoals tekst en afbeeldingen). Het Adobe Extensible Metadata Platform (XMP) is een standaard voor de verwerking van metagegevens van documenten. De XMP Utilities-service kan XMP-metagegevens ophalen uit PDF-documenten en XMP-metagegevens exporteren naar PDF-documenten.
De API verwijzingsdocumentatieverstrekt gedetailleerde informatie over alle parameters, authentificatiemethodes, en de diensten die door APIs worden verleend. De API-naslagdocumentatie is ook beschikbaar in de indeling .yaml. U kunt de .yaml downloaden en uploaden naar Postman om de functionaliteit van API's te controleren.
Documentconversie
Converteren naar en valideren van documenten die voldoen aan PDF/A
Met API's voor documentconversie via communicatie kunt u een PDF-document converteren naar PDF/A. U kunt de API's gebruiken om een PDF-document te converteren naar een PDF/A-compatibel document en ook om te bepalen of een PDF-document voldoet aan PDF/A. PDF/A is een archiefindeling die bedoeld is voor het op lange termijn bewaren van de inhoud van het document. De lettertypen worden ingesloten in het document en het bestand wordt niet gecomprimeerd. Een PDF/A-document is daarom doorgaans groter dan een standaard PDF-document. Een PDF/A-document bevat ook geen audio- en video-inhoud. Tot de ondersteunde PDF/A-compatibiliteitsnormen behoren PDF/A-1a, 1b, 2a, 2b, 3a en 3b.
PDF converteren naar XDP convert-pdf-to-xdp
De functie PDF converteren naar XDP valt onder het programma Vroege adopter. U kunt vanaf uw officiële e-mailadres naar aem-forms-ea@adobe.com schrijven om deel te nemen aan het programma voor vroege adoptie en toegang tot de functie te vragen.
Converteert een PDF-document naar een XDP-bestand. Een PDF-document kan alleen succesvol worden geconverteerd naar een XDP-bestand als het PDF-document een XFA-stroom bevat in het woordenboek.
Document Assurance doc-assurance
De DocAssurance-service bevat de API's voor handtekening en versleuteling:
Handtekening-API's
Met de handtekening-API's kunt u de beveiliging en privacy van Adobe PDF-documenten die door uw organisatie worden gedistribueerd en ontvangen, beschermen. De beveiligingsfuncties worden toegepast op het document zelf. Het document blijft gedurende de gehele levenscyclus beveiligd en beheerd. Het document blijft beveiligd buiten de firewall, wanneer het offline wordt gedownload en wanneer het wordt teruggestuurd naar uw organisatie. U kunt de volgende taken uitvoeren met de handtekening-API's:
- Voeg een zichtbaar handtekeningveld toe aan een PDF-document.
- Voeg een onzichtbaar handtekeningveld toe aan een PDF-document.
- Onderteken het opgegeven handtekeningveld in een PDF-document.
- PDF-documenten certificeren
- De handtekening verwijderen uit het opgegeven handtekeningveld in een PDF-document
- Het opgegeven handtekeningveld uit een PDF-document verwijderen
Verwijder de handtekening uit het opgegeven handtekeningveld en verwijder het opgegeven handtekeningveld uit een PDF-document dat beschikbaar is onder het programma voor vroege adoptie. U kunt vanaf uw officiële e-mailadres naar aem-forms-ea@adobe.com schrijven om deel te nemen aan het programma voor vroege adoptie en toegang tot de functie te vragen.
Coderings-API's
Met de API's voor versleuteling kunt u documenten versleutelen en ontsleutelen. Wanneer een document wordt versleuteld, wordt de inhoud ervan onleesbaar. Een geautoriseerde gebruiker kan het document decoderen om toegang tot de inhoud te krijgen. Als een PDF-document is versleuteld met een wachtwoord, moet de gebruiker het wachtwoord voor openen opgeven voordat het document kan worden weergegeven in Adobe Reader of Adobe Acrobat.
U kunt deze taken uitvoeren met de API's voor codering:
- Codeer een PDF-document met een wachtwoord.
- Verwijder op wachtwoord gebaseerde versleuteling uit een PDF-document.
- Haal het type beveiliging op dat op een PDF-document is toegepast.
- Retourneer het beveiligingstype dat op een PDF-document is toegepast.
Zowel handtekening APIs als encryptie APIs zijn Synchrone APIs.
Documenthulpprogramma doc-utility
Documenthulpprogramma's met synchrone API's helpen u bij het converteren van documenten tussen PDF- en XDP-bestandsindelingen. Pas gebruiksrechten toe op een document en extraheer de ingeschakelde gebruiksrechten uit een document. Vraag informatie over een PDF-document. Meer informatie over de gebruiksrechten-API's vindt u hieronder:
Gebruiksrechten-API's (Reader-extensie)
De mogelijkheden voor gebruiksrechten (Reader Extension) vallen onder het programma Vroege adopter. U kunt vanaf uw officiële e-mailadres naar aem-forms-ea@adobe.com schrijven om deel te nemen aan het programma voor vroege adoptie en toegang tot de functie te vragen.
Met de functie Gebruiksrechten kan uw organisatie eenvoudig interactieve PDF-documenten delen door de functionaliteit van Adobe Reader uit te breiden met extra gebruiksrechten. De service werkt met Adobe Reader 7.0 of hoger en voegt gebruiksrechten toe aan een PDF-document. Met deze actie activeert u functies die gewoonlijk niet beschikbaar zijn wanneer een PDF-document wordt geopend met Adobe Reader, zoals het toevoegen van opmerkingen aan een document, het invullen van formulieren en het opslaan van het document.
Wanneer de juiste gebruiksrechten zijn toegevoegd aan PDF-documenten, kunnen ontvangers de volgende activiteiten uitvoeren vanuit Adobe Reader:
- Voltooi PDF-documenten en -formulieren online of offline, zodat ontvangers kopieën lokaal kunnen opslaan voor hun records en de toegevoegde gegevens intact kunnen houden.
- Sla PDF-documenten op een lokale vaste schijf op om het originele document en eventuele aanvullende opmerkingen, gegevens of bijlagen te behouden.
- Bestanden en mediaclips aan PDF-documenten koppelen.
- Onderteken, certificeer en authenticeer PDF-documenten door digitale handtekeningen toe te passen met PKI-technologieën (Public Key Infrastructure) die industriestandaard zijn.
- Ingevulde of geannoteerde PDF-documenten elektronisch verzenden.
- Gebruik PDF-documenten en -formulieren als intuïtieve ontwikkelfront-end voor interne databases en webservices.
- Deel PDF-documenten met anderen, zodat revisoren opmerkingen kunnen toevoegen met intuïtieve opmaakgereedschappen. Deze gereedschappen zijn onder andere elektronische notities, stempels, hooglichten en doorhalen van tekst. Dezelfde functies zijn beschikbaar in Acrobat.
- Ondersteuning voor gestreepte Forms-decodering.
Deze speciale gebruiksrechtenfuncties worden automatisch geactiveerd wanneer een PDF-document met ingeschakelde rechten wordt geopend in Adobe Reader. Wanneer de gebruiker klaar is met het werken met een document waarvoor rechten zijn ingeschakeld, worden deze functies weer uitgeschakeld in Adobe Reader. Ze blijven uitgeschakeld totdat de gebruiker een ander PDF-document met ingeschakelde rechten ontvangt.
Gebruiksrechten in- of uitschakelen
De verschillende gebruiksrechtenmogelijkheden voor de uitbreiding van PDF Reader-services zijn:
-
Decodering van Streepjescodes: Om streepjescodes binnen het document van PDF te decoderen.
-
Commentaren: Om off-line op het document van PDF opmerkingen te maken.
-
Online Commentaren: Om online op het document van PDF commentaar te geven.
-
Digitale Handtekening: Om digitale handtekeningen aan een document van PDF toe te voegen.
-
Dynamische Gebieden van de Vorm: Om vormgebieden aan een document van PDF toe te voegen.
-
Dynamische Pagina's van de Vorm: Om vormpagina's aan een document van PDF toe te voegen.
-
Ingebedde Dossiers: Om dossiers binnen een document van PDF in te bedden.
-
de Invoer van de Gegevens van de Vorm: Om vormgegevens in een document van PDF in te voeren.
-
de Uitvoer van de Gegevens van de Vorm: Om vormgegevens in een document van PDF in te voeren.
-
Vulling van de Vorm: Om vormgebieden binnen een document van PDF te vullen.
-
Online Forms: Om tot een Webdienst of gegevensbestand van een document van PDF toegang te hebben.
-
legt Zelfstandig voor: Om formuliergegevens off-line van een document van PDF voor te leggen.
Andere mogelijkheden
- Bericht: Het bericht dat binnen Adobe Acrobat Reader op het openen van een document van PDF met één of meerdere toegepaste gebruiksrechten wordt getoond.
- Wachtwoord van de Ontgrendeling: Het wachtwoord dat voor het openen van een gecodeerd document van PDF wordt vereist. Dit is doorgaans het wachtwoord voor het openen van het document, maar als het PDF-document extra wordt beveiligd door een wachtwoord voor machtigingen, kunt u het ook openen.
Typen communicatie-API's types
Communicatie biedt HTTP-API's voor het genereren van documenten op aanvraag en in batches:
-
Synchrone APIs zijn geschikt voor op bestelling, lage latentie, en enige scenario's van de verslagdocumentgeneratie. Deze API's zijn geschikter voor gebruiksgevallen die zijn gebaseerd op handelingen van gebruikers. Als u bijvoorbeeld een document genereert nadat een gebruiker een formulier heeft ingevuld.
-
Partij APIs (Asynchrone APIs) is geschikt voor geplande, hoge productie, en veelvoudige scenario's van de documentgeneratie. Met deze API's worden documenten batchgewijs gegenereerd. Zo worden telefoonrekeningen, creditcardafschriften en uitkeringsafschriften elke maand gegenereerd.
Onboarding
Communicatiecapaciteit is beschikbaar als zelfstandige en add-on module voor Forms as a Cloud Service-gebruikers. Je kunt contact opnemen met het Adobe Sales-team of je Adobe-vertegenwoordiger om toegang aan te vragen. Adobe maakt toegang voor uw organisatie mogelijk en biedt de vereiste rechten aan de persoon die is aangewezen als beheerder in uw organisatie. De beheerder kan toegang verlenen aan uw Forms as a Cloud Service-ontwikkelaars (gebruikers) van uw organisatie voor het gebruik van de API's.
Na het instappen, om Communicatie vermogen voor uw milieu van Forms as a Cloud Service toe te laten:
-
Meld u aan bij Cloud Manager en open AEM Forms as a Cloud Service Instance.
-
Open de optie Programma bewerken, ga naar het tabblad Oplossingen en invoegtoepassingen en selecteer de optie Forms - Communications .
Als u de optie Forms - Digital Enrollment al hebt ingeschakeld, selecteert u de optie Forms - Communications Add-On .
-
Klik op Update.
-
Stel de bouwstijlpijpleiding in werking. Nadat de bouwstijlpijpleiding slaagt, Communicatie APIs wordt toegelaten voor uw milieu.
# Allow Forms Doc Generation requests/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }