Rendering

API for starting template rendering from kVASy XML

This API accepts raw kVASy XML in the request body, maps it to an Output.Rocks rendering request, and starts document rendering asynchronously. The child element directly below `<formular>` is dynamic and usually matches the form/template name, for example `<abschlagsformular>` or `<rechnungsformular>`.

POST/api/rendering/kvasy

API for starting template rendering from kVASy XML

curl --request POST \
  --url 'https://app.output.rocks/api/rendering/kvasy?format=pdf&pdfUniversalAccessibility=false' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/xml' \
  --data '{
  "id": "string"
}'

201

application/json

{
  "id": 12345,
  "externalId": "external-id",
  "template": "my-invoice",
  "format": "pdf",
  "webhook": "my-webhook",
  "comment": "My Comment",
  "emailServer": "my-smtp"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

format

stringdefault:pdf

Document format to render.

comment

string

Rendering comment.

webhook

string

Webhook (identifier) to execute after document rendering.

emailServer

string

Identifier of Email-Server configuration in Output.Rocks.

metadata

string

Optional metadata as a JSON string to be used in webhooks.

pdfUniversalAccessibility

booleandefault:false

Enable PDF universal accessibility.

Request Body

application/xml

required

Raw kVASy XML payload.

{
  "id": "string"
}

text/xml

required

Raw kVASy XML payload.

{
  "id": "string"
}

Response

201application/json

Rendering resource created

integer

Identifier generated by Output.Rocks.

Example: 12345

externalId

string

External id

Example: "external-id"

template

stringrequired

Template identifier.

Example: "my-invoice"

format

enum<string>

Document format to render

Available options: pdfdocodtrtfhtmltxt

Example: "pdf"

webhook

string

Webhook (identifier) to execute after document rendering.

Example: "my-webhook"

comment

string

Rendering Comment.

Example: "My Comment"

emailServer

string

Identifier of Email-Server configuration in Output.Rocks

Example: "my-smtp"