Använd synkron bearbetning sync-processing-introduction
Forms as a Cloud Service - Med API:er för kommunikation kan ni skapa, sammanställa och leverera varumärkesorienterad och personaliserad kommunikation som affärskorrespondenser, dokument, kontoutdrag, kravbrev, förmånsmeddelanden, kravbrev, månadsräkningar och välkomstpaket. Du kan använda API:er för kommunikation för att kombinera en mall (XFA eller PDF) med kunddata för att generera dokument i formaten PDF, PS, PCL, DPL, IPL och ZPL.
Tänk dig ett scenario där du har en eller flera mallar och flera poster med XML-data för varje mall. Du kan använda API:er för kommunikation för att generera ett utskriftsdokument för varje post. Resultatet är ett icke-interaktivt PDF-dokument. Ett icke-interaktivt PDF-dokument tillåter inte att användare anger data i sina fält.
Forms as a Cloud Service - Communications innehåller on demand- och batch-API:er (asynkrona API:er) för schemalagd dokumentgenerering:
-
Synkrona API:er är lämpliga för dokumentgenerering on demand, med låg latens och en post. Dessa API:er lämpar sig bättre för användaråtgärdsbaserade användningsfall. Du kan till exempel skapa ett dokument när en användare har fyllt i ett formulär.
-
API:er för gruppbearbetning (asynkrona API:er) är lämpliga för schemalagd hög genomströmning vid användning av flera dokumentgenereringar. Dessa API:er genererar dokument gruppvis. Till exempel telefonräkningar, kontoutdrag och förmånsräkningar som genereras varje månad.
Använd synkrona åtgärder batch-operations
En synkron åtgärd är en process där dokument genereras linjärt. Dessa API:er klassificeras som single-tenant-API:er och multi-tenant-API
Single-tenant-API:er
- API för dokumentgenerering
- API:er för dokumentbearbetning
Autentisera ett single-tenant-API
API-åtgärder för en innehavare har stöd för två typer av autentisering:
-
Grundläggande autentisering: Grundläggande autentisering är ett enkelt autentiseringsschema som är inbyggt i HTTP-protokollet. Klienten skickar HTTP-begäranden med auktoriseringshuvudet som innehåller ordet Basic följt av ett blanksteg och en base64-kodad sträng med användarnamn:password. Om du till exempel vill auktorisera som administratör/administratör skickar klienten Basic [base64-encoded string username]: [base64-kodat stränglösenord].
-
Tokenbaserad autentisering: Tokenbaserad autentisering använder en åtkomsttoken (Bearer-autentiseringstoken) för att göra begäranden till Experience Manager as a Cloud Service. AEM Forms as a Cloud Service tillhandahåller API:er för att på ett säkert sätt hämta åtkomsttoken. Så här hämtar och använder du token för att autentisera en begäran:
- Hämta as a Cloud Service autentiseringsuppgifter för Experience Manager från Developer Console.
- Installera as a Cloud Service autentiseringsuppgifter för Experience Manager i din miljö. (Programserver, webbserver eller andra icke-AEM servrar) som är konfigurerade att skicka begäranden till (ringa anrop) molntjänsten.
- Generera en JWT-token och ersätt den med Adobe IMS API:er för en åtkomsttoken.
- Kör Experience Manager-API:t med åtkomsttoken som en Bearer-autentiseringstoken.
- Ange lämplig behörighet för den tekniska kontoanvändaren i Experience Manager-miljön.
note note NOTE Adobe rekommenderar att du använder tokenbaserad autentisering i en produktionsmiljö.
(Endast för API:er för dokumentgenerering) Konfigurera resurser och behörigheter
Följande krävs för att använda synkrona API
- Användare med administratörsbehörighet för Experience Manager
- Överför mallar och annat material till Experience Manager Forms Cloud Service
(Endast för API:er för dokumentgenerering) Överför mallar och andra resurser till din Experience Manager-instans
En organisation har vanligtvis flera mallar. Till exempel en mall var för kreditkortskontoutdrag, förmånskontoutdrag och ansökningar. Överför alla sådana XDP- och PDF-mallar till din Experience Manager-instans. Så här överför du en mall:
- Öppna instansen Experience Manager.
- Gå till Forms > Forms och dokument
- Klicka på Skapa > Mapp och skapa en mapp. Öppna mappen.
- Klicka på Skapa > Filöverföring och överför mallarna.
Anropa ett API
The API-referensdokumentation innehåller detaljerad information om alla parametrar, autentiseringsmetoder och olika tjänster som tillhandahålls av API:er. API-referensdokumentationen innehåller även API-definitionsfilen i .yaml-format. Du kan hämta .yaml-filen och överföra den till Postman för att kontrollera API:ernas funktioner.