Documentation.

Overview

Onlinedisken turns structured form data into editable DOCX documents. Your application collects data, sends a JSON request, and uses a document template configured in the document engine.

Quick start

1. Sign in to WordPress and open Convert to Word Studio to manage your own templates and API key.
2. Create or select an active template and note its API slug. The plugin includes an example letter template with fields such as overskrift, navn, dato and indhold.
3. Generate an API key in Studio and save it in a secure server-side secret store. You will only see the full key at generation time.
4. Call GET /status or GET /templates to test credentials and discover template fields.
5. Send a JSON body with a template slug and matching top-level fields to POST /create.
6. Decode the base64 response into a .docx file, or request direct download.

Authentication

All four API endpoints require HTTPS, an active API key and appropriate WordPress capabilities. Pass the key through one of these supported methods. No API username header is required.

X-CTWS-API-Key: YOUR_API_KEY
Accept: application/json

Alternatively: Authorization: Bearer YOUR_API_KEY. For JSON POST requests, use Content-Type: application/json. A Studio account has one API key at a time; regenerating it replaces the previous key.

Check API status

Returns the product version, server component availability and active templates belonging to the API key owner.

curl 'https://YOUR-DOMAIN/wp-json/convert-to-word-studio/v1/status' \
  -H 'Accept: application/json' \
  -H 'X-CTWS-API-Key: YOUR_API_KEY'

Response fields: status (ok), product, version, generated_at (ISO 8601), ziparchive (boolean), domdocument (boolean), and templates (array of name, slug, version).

Templates and fields

Only the authenticated user's active templates are listed. Use this endpoint to discover field names and input requirements instead of guessing.

curl 'https://YOUR-DOMAIN/wp-json/convert-to-word-studio/v1/templates' \
  -H 'X-CTWS-API-Key: YOUR_API_KEY'

The JSON response contains status: "ok" and a templates array. Each template has name, slug, description, version and fields. Each field exposes key, label, type, required and options.

Within the Studio document editor, insert placeholders such as ${navn}; conditional content supports {{#if navn}}...{{/if}} and {{#unless navn}}...{{/unless}}.

Create a DOCX document

Send the active template slug as template (or template_slug) and its field values at the top level. This example uses the built-in sample letter template's field names; obtain the actual slug from /templates.

curl -X POST 'https://YOUR-DOMAIN/wp-json/convert-to-word-studio/v1/create' \
  -H 'Content-Type: application/json' \
  -H 'X-CTWS-API-Key: YOUR_API_KEY' \
  -d '{
    "template": "YOUR_ACTIVE_TEMPLATE_SLUG",
    "overskrift": "Example letter",
    "navn": "Example ApS",
    "dato": "2026-10-13",
    "indhold": "<p>Document text</p>",
    "filename": "example-letter.docx"
  }'

Successful JSON response: status: "success", filename, template (slug), document_id (may be null when not archived), and base64 containing the document bytes. Invalid input returns a WordPress REST error, not this success schema.

Merge DOCX files

Merge between 2 and 20 existing DOCX files. Send each input document as Base64 in an array using content or base64. The result is a new DOCX file.

{
  "filename": "combined.docx",
  "files": [
    {"base64": "BASE64_OF_FIRST_DOCX"},
    {"base64": "BASE64_OF_SECOND_DOCX"}
  ]
}

Send this body as JSON with the API key header. The files array may also be the top-level JSON body. The successful JSON response includes status, filename, document_id and base64. Inputs must be valid DOCX files; raw PDF or DOC files are not supported by this endpoint.

Download formats

By default, /create and /merge return JSON with Base64-encoded DOCX bytes. Decode the base64 value in your server application and write it to a .docx file.

For a direct binary DOCX response, add ?download=1 to the URL or send Accept: application/vnd.openxmlformats-officedocument.wordprocessingml.document. The response then uses the DOCX content type and a file attachment disposition rather than JSON.

Limits and storage

These are plugin-level limits. The monthly limits shown on Onlinedisken pricing plans are not enforced by this plugin version on their own.

Troubleshooting and error codes

WordPress REST errors typically include code, message and data.status. Log the HTTP status and safe error code; never log live keys or document contents.

Security

Keep your API key server-side, never in public JavaScript or a publicly distributed app. Use HTTPS. A key identifies its owner; clients cannot impersonate another user using a user-ID field. Treat generated document contents as confidential. Rotate the key if compromised and store only the new key in your application's secrets.

Requirements: WordPress 6.0+, PHP 8.0+, and the PHP ZipArchive and DOMDocument extensions.

API reference

Source: Convert to Word Studio 1.0.2, includes/class-ctws-api.php, includes/class-ctws-db.php, includes/class-ctws-document-service.php and the bundled README. Documentation is version-specific.