On-Demand Documents

Documents are created on the per-request basis. No permanent document storage is provided. Document data must always be transmitted in the request in order to get a valid document. Each document creation is subject to a fee.

Try it out

When you have selected a Document template and prepared some suitable data that match the Document schema of the template, you can generate your first document.

Alternatively, you can just use the predefined example values for the DemoDoc10.pdf.

Using Swagger UI

The most comfortable way is to use the Swagger UI:

  • fill-in the processor and templateName
  • select a format that is supported by the associated processor
  • clear the staging parameters (referenceNumber, referenceType, documentType and retentionDaysLimit) – otherwise the document would be stored in the Document Service and this use-case is not covered in this chapter
  • you can define the requested document file name in documentName (w/o the file extension)
  • upload your example file to the Request body; ensure that the content type matches your data format (XML and JSON is supported)

Now execute the request

You get a response like this:

You then use the Download file link to save the response into a file on your computer.

Using readme.io API Reference

The same request can be theoretically executed here, but there are the following problems:

  • When your data example is in XML format, the request must contain this header: Content-Type: application/xml
  • It is unclear how the body with the example data is actually uploaded (might use multipart form?)
  • The generated PDF response is binary and it is hard to download/save it correctly

Using command line