Generatie-API Referentie

Gebruik deze pagina wanneer u een systeemkoppeling implementeert. Begin voor de functionele inrichting met Gekoppelde systemen en Documenten genereren.

Verzoek

Een generatieverzoek bepaalt:

De tenant.
De doelomgeving.
De template of gedeployde documentdefinitie.
Eventuele variantselectie.
Het data-object waarmee documentvelden worden gevuld.
Eventuele outputafhandeling, zoals waar het gegenereerde bestand wordt opgeslagen of teruggegeven.

Neem het exacte JSON-contract uit het gedeployde API-contract van de Suite-versie die u gebruikt. Kopieer geen voorbeeldpayloads uit projectnotities naar productiecode zonder het actuele contract te controleren.

Resultaatafhandeling

Behandel generatie als een job. De aanroeper moet de jobidentificatie bewaren, pollen of abonneren volgens het integratiepatroon, en succes, validatiefout, renderfout en annulering apart afhandelen.

PDF/A-output wordt bepaald door de configuratie van de gedeployde template. Modelleer archiefoutput niet als optie per verzoek, tenzij uw integratie een expliciete productfunctie heeft om een andere gedeployde template of variant te kiezen.

Autorisatie

Gebruik een aparte integratie-identiteit per gekoppeld systeem. Geef alleen toegang tot de tenant en omgeving die het systeem nodig heeft. Roteer credentials als onderdeel van normaal beheer.

Validatie

Valideer met realistische voorbeelden voordat productie wordt aangezet. Een technisch geldige payload kan nog steeds een juridisch of operationeel verkeerd document opleveren wanneer de verkeerde zaakwaarde is gekoppeld.