How can we help you?

Advanced documentation search

Render Your First Document

Product: FeraRender Topic: Getting Started Versions: Applies to all documented versions Current
Written by user
Updated

Complete a first render using an existing template and XML data.

Audience: Application users and developers
Recommended visibility: Public

Overview

Complete a first render using an existing template and XML data. Use this article before changing production templates or writing an integration. It establishes the expected workflow and the terms used by the rest of the library.

Key points

  • Choose a template by UUID or name.
  • Confirm the template is READY or is a non-composite full template.
  • Supply valid XML matching the template data contract.
  • Choose DOCX, PDF, or metadata output.
  • Save the returned binary using the response filename.

Example

curl --request POST "<render-base-url>/api/v1/docx" \
  --header "x-auth-token: <token>" \
  --header "instance: <instance-uuid>" \
  --header "Content-Type: application/json" \
  --data '{
    "owner": "<instance-uuid>",
    "name": "Welcome Letter",
    "xml": "<data><Client><displayName>Alex Example</displayName></Client></data>"
  }' \
  --output "Welcome Letter.docx"

Replace bracketed values with values issued for the target environment. Never place production tokens, API keys, or client data in screenshots or public examples.

Recommended procedure

  1. Confirm that you have the correct instance and permission.
  2. Identify the input data and required output format.
  3. Use a non-production template and representative sample data for the first test.
  4. Record the template UUID, output mode, and any validation result.

Troubleshooting

The result format is wrong

Confirm the workflow and template output setting, then verify any asPdf, metadata, or content-type option.

The template cannot be found

Confirm the instance, owner, UUID or exact name, and whether a global template must first be imported.

The request is unauthorized

Check the token, instance header, and required view, edit, native-XSLT, or render permission.

Related documentation

Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.