Integratie voor generieke serverlevering

Hoe Create documenten retourneert naar externe systemen.

Leveringsintegraties leveren gegevens aan systemen van derden nadat een document is gegenereerd. De integratie voor generieke serverlevering verzendt documentinformatie naar een app van derden, zodat deze het document met een andere aanroep kan ophalen. De app reageert met de URI waarnaar Create de gebruiker moet navigeren na een succesvolle levering. Standaard navigeert Create de gebruiker terug naar het overzicht.

De integratie voor generieke serverlevering wordt ingesteld met de volgende parameters:

• Naam;
• Een naam voor de integratie zodat deze eenvoudig herkenbaar is;
• Authenticatie;
• Identificatietype;
• Geen, Statische Header, WSO2, OAuth2, OAuth2ClientCredentials;
• Elk type behalve Geen vereist eigen parameters;
• Delivery Endpoint URI;
• Waar de gegevens naartoe moeten worden geleverd;
• Statische headersleutel;
• Statische headerwaarde.

Create doet een POST-aanvraag met de volgende indeling:

{
  "documentUri": "",
  "documentType": "",
  "templateId": ""
}

De eigenschappen zijn:

• documentUri;
  • Waar het gegenereerde document kan worden opgehaald.
• documentType;
  • "Document" of "Element".
• templateId;
  • Het ID van het sjabloon dat is gebruikt om het document te genereren.

De volgende response-body wordt verwacht:

{
  "navigateToUri": ""
}

• navigateToUri;
  • De URI waarnaar de gebruiker moet worden genavigeerd na succesvolle levering.