AEM Forms as a Cloud Service Communication APIs communications-apis-overview

Versionstillgänglighet

• AEM 6.5: Översikt över AEM Document Services
• AEM as a Cloud Service: Den här artikeln

Introduktion

Med API:er för kommunikation i AEM Forms as a Cloud Service kan ni skapa varumärkesgodkända, personaliserade och standardiserade dokument för era affärsbehov. Med dessa kraftfulla API:er kan du generera, manipulera och skydda dokument programmatiskt, oavsett om det är vid behov eller i gruppprocesser med stora volymer.

Viktiga fördelar

API Capabilities Overview

API:er för kommunikation har en omfattande uppsättning funktioner för dokumentbearbetning som är organiserade i följande funktionsområden:

API-referensdokumentationen innehåller detaljerad information om alla parametrar, autentiseringsmetoder och olika tjänster som tillhandahålls av API:er. API-referensdokumentationen finns också i .yaml-format. Du kan hämta .yaml-filen och överföra den till Postman för att kontrollera API:ernas funktioner.

Dokumentgenerering

API:er för dokumentgenerering för kommunikation hjälper dig att kombinera en mall (XFA eller PDF) med kunddata (XML) för att generera dokument i PDF och utskriftsformat som PS, PCL, DPL, IPL och ZPL. Dessa API:er använder PDF- och XFA-mallar med XML-data för att generera ett enda dokument vid behov eller flera dokument med hjälp av ett batchjobb.

Vanligtvis skapar du en mall med Designer och använder kommunikationsAPI:er för att sammanfoga data med mallen. Programmet kan skicka utdatadokumentet till en nätverksskrivare, en lokal skrivare eller till ett lagringssystem för arkivering. Ett typiskt exempel och anpassade arbetsflöden ser ut så här:

Beroende på hur de används kan du även göra dessa dokument tillgängliga för hämtning via din webbplats eller en lagringsserver.

Nyckelfunktioner för dokumentgenerering

Skapa PDF-dokument create-pdf-documents

Du kan använda API:erna för dokumentgenerering för att skapa ett PDF-dokument som baseras på en formulärdesign och XML-formulärdata. Utdata är ett icke-interaktivt PDF-dokument. Användarna kan alltså inte ange eller ändra formulärdata. Ett grundläggande arbetsflöde är att sammanfoga XML-formulärdata med en formulärdesign för att skapa ett PDF-dokument. I följande bild visas hur du sammanfogar en formulärdesign och XML-formulärdata för att skapa ett PDF-dokument.

Bild: Vanligt arbetsflöde för att skapa ett PDF-dokument

API:t för dokumentgenerering returnerar det genererade PDF-dokumentet. Du kan också överföra de genererade PDF-filerna till Azure Blob Storage.

Överför genererade PDF-filer med hjälp av dokumentgenererings-API:t till Azure Blob Storage-funktionen under Tidigt Adobe-program. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

Skapa dokument för PostScript (PS), Printer Command Language (PCL) och Zebra Printing Language (ZPL) create-PS-PCL-ZPL-documents

Du kan använda API:er för dokumentgenerering för att skapa dokument i formaten PostScript (PS), Printer Command Language (PCL) och Zebra Printing Language (ZPL) som baseras på en XDP-formulärdesign eller ett PDF-dokument. Dessa API:er hjälper till att sammanfoga en formulärdesign med formulärdata för att generera ett dokument. Du kan spara dokumentet i en fil och utveckla en anpassad process för att skicka det till en skrivare.

Bearbeta gruppdata för att skapa flera dokument processing-batch-data-to-create-multiple-documents

Du kan använda API:er för dokumentgenerering för att skapa separata dokument för varje post i en XML-batchdatakälla. Du kan generera dokument i både gruppläge och asynkront läge. Du kan konfigurera olika parametrar för konverteringen och sedan starta gruppbearbetningen.

Dokumentmanipulering

API:er för dokumentbearbetning (Document Transformation) hjälper dig att kombinera och ordna om PDF-dokument. Vanligtvis skapar du en DX och skickar den till dokumenthanterings-API:er för att montera eller ordna om ett dokument. DDX-dokumentet innehåller instruktioner om hur du använder källdokumenten för att skapa en uppsättning med obligatoriska dokument. DDX-referensdokumentationen innehåller detaljerad information om alla åtgärder som stöds.

Funktioner för hantering av nyckeldokument

Sammanställa PDF-dokument

Du kan använda API:erna för dokumentmanipulering för att samla ihop två eller flera PDF- eller XDP-dokument till ett enda PDF-dokument eller PDF Portfolio. Här är några sätt att sammanställa PDF-dokument:

Bild: Sammanställa ett enkelt PDF-dokument från flera PDF-dokument

Disassemblera PDF-dokument

Du kan använda API:erna för dokumentbearbetning för att demontera ett PDF-dokument. API:erna kan extrahera sidor från källdokumentet eller dela upp ett källdokument baserat på bokmärken. Vanligtvis är den här uppgiften användbar om PDF-dokumentet ursprungligen skapades från många enskilda dokument, till exempel en samling programsatser.

Bild: Dela upp ett källdokument baserat på bokmärken i flera dokument

Extrahering av dokument

Funktionen för dokumentextrahering är under Tidiga Adobe-program. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

Med dokumentextraheringstjänsten kan du hämta egenskaperna för ett PDF-dokument, t.ex. användarbehörighet, PDF-egenskaper och metadata. Extraheringsfunktionerna är:

API-referensdokumentationen innehåller detaljerad information om alla parametrar, autentiseringsmetoder och tjänster som tillhandahålls av API:er. API-referensdokumentationen finns också i .yaml-format. Du kan hämta .yaml-filen och överföra den till Postman för att kontrollera API:ernas funktioner.

Dokumentkonvertering

Konvertera till och validera PDF/A-dokument

API:er för dokumentkonvertering för kommunikation hjälper till att konvertera ett PDF-dokument till PDF/A. Du kan använda API:erna för att konvertera ett PDF-dokument till ett PDF/A-kompatibelt dokument och även för att avgöra om ett PDF-dokument är PDF/A-kompatibelt. PDF/A är ett arkiveringsformat som används för långtidsarkivering av dokumentets innehåll. Teckensnitten bäddas in i dokumentet och filen är okomprimerad. Därför är ett PDF/A-dokument vanligtvis större än ett vanligt PDF-dokument. Ett PDF/A-dokument innehåller inte heller ljud- och videoinnehåll. De kompatibilitetsstandarder för PDF/A som stöds är PDF/A-1a, 1b, 2a, 2b, 3a och 3b.

Konvertera PDF till XDP convert-pdf-to-xdp

Funktionen för att konvertera PDF till XDP finns i Tidigt Adobe-program. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

Konverterar PDF-dokument till XDP-filer. För att ett PDF-dokument ska kunna konverteras till en XDP-fil måste PDF-dokumentet innehålla en XFA-ström i ordlistan.

Document Assurance doc-assurance

Tjänsten DocAssurance innehåller API:erna för signatur och kryptering:

Signatur-API:er

Med signatur-API:erna kan din organisation skydda säkerheten och sekretessen för Adobe PDF-dokument som den distribuerar och tar emot. Säkerhetsfunktionerna tillämpas på själva dokumentet. Dokumentet förblir säkert och styrs under hela livscykeln. Dokumentet förblir säkert även utanför brandväggen när det laddas ned offline och när det skickas tillbaka till organisationen. Du kan utföra följande uppgifter med signatur-API

Ta bort signaturen från det angivna signaturfältet och ta bort det angivna signaturfältet från ett PDF-dokument som är tillgängligt under det tidiga adopterprogrammet. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

Krypterings-API:er

Med krypterings-API:erna kan du kryptera och dekryptera dokument. När ett dokument är krypterat blir innehållet oläsligt. En behörig användare kan dekryptera dokumentet för att få åtkomst till innehållet. Om ett PDF-dokument är krypterat med ett lösenord måste användaren ange det öppna lösenordet innan dokumentet kan visas i Adobe Reader eller Adobe Acrobat.

Du kan utföra följande uppgifter med krypterings-API

Både signatur-API:er och krypterings-API:er är synkrona API:er.

Dokumentverktyg doc-utility

Dokumentverktyg med synkrona API:er hjälper dig att konvertera dokument mellan filformaten PDF och XDP. Använd användarrättigheter för ett dokument och extrahera de aktiverade användningsrättigheterna från ett dokument. Fråga om information om ett PDF-dokument. Information om API:er för användningsrättigheter anges nedan:

API:er för användningsrättigheter (Reader Extension)

Funktionen Användningsrättigheter (Reader Extension) finns under Tidiga Adobe-programmet. Du kan skriva till aem-forms-ea@adobe.com från ditt officiella e-post-id för att gå med i det tidiga adopterprogrammet och begära åtkomst till funktionen.

Med rättigheten kan man enkelt utbyta interaktiva PDF-dokument genom att utöka funktionaliteten i Adobe Reader med ytterligare användarrättigheter. Tjänsten fungerar med Adobe Reader 7.0 eller senare och lägger in användarrättigheter i ett PDF-dokument. Den här åtgärden aktiverar funktioner som normalt inte är tillgängliga när ett PDF-dokument öppnas med Adobe Reader, t.ex. för att lägga till kommentarer i ett dokument, fylla i formulär och spara dokumentet.

När PDF-dokument har rätt användarbehörighet kan mottagarna göra följande i Adobe Reader:

Dessa specialfunktioner aktiveras automatiskt när ett rättighetsaktiverat PDF-dokument öppnas i Adobe Reader. När användaren är klar med ett rättighetsaktiverat dokument inaktiveras dessa funktioner igen i Adobe Reader. De är inaktiverade tills användaren får ett annat rättighetsaktiverat PDF-dokument.

Aktivera eller inaktivera användningsrättigheter

De olika funktionerna för användarrättigheter för att utöka PDF Reader tjänster är:

Andra funktioner

Typer av API:er för kommunikation types

Kommunikationen tillhandahåller HTTP-API:er för on demand- och batchdokumentgenerering:

Onboarding

Kommunikationsfunktioner finns som fristående modul och tilläggsmodul för användare av Forms as a Cloud Service. Du kan kontakta Adobe säljteam eller din Adobe-representant för att få åtkomst. Adobe aktiverar åtkomst för organisationen och tillhandahåller behörigheter åt den person som utses till administratör i organisationen. Administratören kan ge Forms as a Cloud Service-utvecklare (användare) i organisationen åtkomst till API:erna.

Efter introduktionen, för att aktivera kommunikationsfunktioner för din Forms as a Cloud Service-miljö:

Ytterligare resurser see-also