AEM Forms as a Cloud Service communicatie-API's frequently-asked-questions
Met communicatiemogelijkheden kunt u documenten maken die door uw merk zijn goedgekeurd, gepersonaliseerd en gestandaardiseerd, zoals zakelijke correspondentie, instructies, aanvraagverwerkingsbrieven, aankondigingen van voordelen, maandelijkse facturen of welkomstkits.
De mogelijkheid biedt API's om de documenten te genereren en te bewerken. U kunt een document op verzoek genereren of bewerken of een batchtaak maken om meerdere documenten met gedefinieerde intervallen te genereren. Communicatie-API's bieden:
-
gestroomlijnde mogelijkheden voor het genereren van documentatie op aanvraag en batchverwerking.
-
de mogelijkheid om PDF-documenten op aanvraag te combineren, opnieuw te rangschikken en te valideren.
-
HTTP-API's voor eenvoudigere integratie met externe systemen. Afzonderlijke API's voor bewerkingen op aanvraag (lage latentie) en batchbewerkingen (bewerkingen met hoge doorvoer) worden opgenomen.
-
een veilige toegang tot gegevens. Communicatie APIs verbindt met en heeft toegang tot gegevens slechts van klant-aangewezen gegevensbewaarplaatsen, die mededelingen hoogst veilig maken.
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 de indelingen PDF en Afdrukken, zoals de indelingen PS, PCL, DPL, IPL en ZPL. Deze API's gebruiken PDF- en XFA-sjablonen met XML-gegevens om één document op bestelling of meerdere documenten te produceren die een partijbaan gebruiken.
Doorgaans maakt u een sjabloon met Designer en gebruik Communicatie 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.
Voorbeelden van API's voor het genereren van documenten zijn:
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: Standaardworkflow voor het maken van een PDF-document
PostScript (PS), Printer Command Language (PCL), Zebra Printing Language (ZPL)-document maken create-PS-PCL-ZPL-documents
Met API's voor het genereren van documenten kunt u PostScript- (PS), PCL-documenten (Printer Command Language) en ZPL-documenten (Zebra Printing Language) maken op basis van 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. De DDX-document Hier vindt u instructies over het gebruik van de brondocumenten om een set vereiste documenten te maken. De DDX-referentiedocumentatie biedt gedetailleerde informatie over alle ondersteunde bewerkingen. Voorbeelden van documentmanipulatie zijn:
PDF-documenten samenstellen
Met de API's voor documentmanipulatie kunt u twee of meer PDF- of XDP-documenten samenvoegen 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. Deze taak is meestal 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 capaciteit van de Extractie van het Document is onder het 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.
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 zijn in- of uitgeschakeld voor Adobe Acrobat Reader-uitbreidbaarheid naar een PDF-document.
- Haal de metagegevens op die aanwezig zijn in een PDF-document. De metagegevens zijn gegevens over het document (die verschillen van de inhoud van het document, zoals tekst en afbeeldingen). Het Adobe Extensible Metadata Platform (XMP) is een standaard voor de verwerking van documentmetagegevens. Met de XMP Utilities kunt u XMP metagegevens ophalen uit PDF-documenten en XMP metagegevens exporteren naar PDF-documenten.
De API-naslagdocumentatie verstrekt 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
Via API's voor documentconversie kunt u een PDF-document converteren naar PDF/A. U kunt de API's gebruiken om een PDF-document te converteren naar een document dat voldoet aan de PDF/A-standaard en ook om te bepalen of een PDF-document voldoet aan de PDF/A-standaard. PDF/A is een archiefindeling die is bedoeld 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.
PDF omzetten in XDP convert-pdf-to-xdp
De convert PDF naar XDP-mogelijkheid valt onder het programma 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.
Zet een PDF-document om in een XDP-bestand. Een PDF-document kan alleen met succes worden geconverteerd naar een XDP-bestand als het PDF-document een XFA-stroom bevat in het woordenboek.
Documentcontrole 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.
- Een PDF-document certificeren
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 met een wachtwoord is versleuteld, moet de gebruiker het wachtwoord voor openen opgeven voordat het document in Adobe Reader of Adobe Acrobat kan worden weergegeven.
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.
- Hiermee haalt u het type beveiliging op dat op een PDF-document is toegepast.
- Retourneer het beveiligingstype dat op een PDF-document is toegepast.
Zowel handtekening-API's als versleutelings-API's zijn Synchrone API's.
Documenthulpprogramma doc-utility
Met behulp van documenthulpprogramma's met synchrone API's kunt u documenten omzetten tussen PDF- en XDP-bestandsindelingen. Pas gebruiksrechten toe op een document en extraheer de ingeschakelde gebruiksrechten uit een document. Vraag informatie over een document van PDF. Nadere informatie over de gebruiksrechten-API's vindt u hieronder:
Gebruiksrechten-API's (extensie Reader)
De mogelijkheden voor gebruiksrechten (extensie Reader) vallen 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 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 voor PDF-documenten de juiste gebruiksrechten zijn toegevoegd, 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 ontwikkelvoorkant van 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 mogelijkheden voor speciale gebruiksrechten 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 mogelijkheden van gebruiksrechten voor het uitbreiden van de diensten van de Reader van de PDF zijn:
-
Decodering streepjescodes: Streepjescodes decoderen in het PDF-document.
-
Opmerkingen: Als u een opmerking offline wilt plaatsen in het PDF-document.
-
Opmerkingen online: U kunt als volgt online opmerkingen toevoegen aan het document PDF.
-
Digitale handtekening: digitale handtekeningen toevoegen aan een PDF-document.
-
Dynamische formuliervelden: Formuliervelden toevoegen aan een PDF-document.
-
Dynamische formulierpagina's: Formulierpagina's toevoegen aan een PDF-document.
-
Ingesloten bestanden: Bestanden insluiten in een PDF-document.
-
Formuliergegevens importeren: Formuliergegevens importeren in een PDF-document.
-
Formuliergegevens exporteren: Formuliergegevens importeren in een PDF-document.
-
Formulier invullen: Formuliervelden invullen in een PDF-document.
-
Online Forms: Toegang tot een webservice of database vanaf een PDF-document.
-
Zelfstandig verzenden: Formuliergegevens offline verzenden vanuit een PDF-document.
Andere mogelijkheden
- Bericht: Het bericht dat in Adobe Acrobat Reader wordt weergegeven bij het openen van een PDF-document waarop een of meer gebruiksrechten zijn toegepast.
- Wachtwoord ontgrendelen: Het wachtwoord dat is vereist voor het openen van een versleuteld PDF-document. Dit is doorgaans het wachtwoord voor het openen van het document, maar als het PDF-document extra wordt beveiligd door een wachtwoord voor machtigingen, kan een van beide worden gebruikt om het document te openen.
De API-naslagdocumentatie verstrekt 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.
Typen communicatie-API's types
Communicatie biedt HTTP-API's voor het genereren van documenten op aanvraag en in batches:
-
Synchrone API's zijn geschikt voor on-demand, lage latentie en scenario's voor het genereren van één record. 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.
-
Batch-API's (Asynchrone API's) zijn 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 as a Cloud Service Forms-gebruikers. U kunt contact opnemen met het verkoopteam van de Adobe of uw Adobe 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 as a Cloud Service Forms-ontwikkelaars (gebruikers) van uw organisatie om de API's te gebruiken.
Na het instappen, om Communicatie vermogen voor uw as a Cloud Service milieu van Forms toe te laten:
-
Meld u aan bij Cloud Manager en open de as a Cloud Service AEM Forms-instantie.
-
Open de optie Programma bewerken, ga naar het tabblad Oplossingen en invoegtoepassingen en selecteer de optie Forms - Communications -optie.
Als u al Forms - Digital Enrollment en selecteert u vervolgens de optie Forms - Communications Add-On -optie.
-
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/*" }