📋Changelog

API version history and breaking changes for Docs-Dispatcher.

Version 1.0.0 (Current)

Released: 2026-02-13

Features

• Initial public API release

• 12 provider integrations across 7 services

• JWT authentication via Dispatcher API

• Sync and async dispatch modes

• Validation endpoints for all services

• Webhook support for eSign and Postal services

• Node.js, PHP, and Java SDKs

Services

• ✅ Invoicing (iPaidThat, Qonto, PennyLane)

• ✅ eSign (Universign, Signaturit)

• ✅ Postal (MySendingBox)

• ✅ SMS (Brevo, OVH, SMS Factor, SMS Magic)

• ✅ Email (SMTP)

• ✅ File (document generation)

• ✅ Upload (file storage)

Endpoints

POST /auth                           # Get JWT
GET  /auth/refresh                   # Refresh JWT
POST /api/:service                   # Dispatch
POST /api/:service/validate          # Validation
POST /api/webhooks/:service/...      # Webhook callbacks
GET  /healthz                        # Health check

Known Limitations

• Sandbox environment not yet available (use validation endpoint)

• Some providers don't support all document types

• Webhook support limited to eSign and Postal services

• CORS not enabled for Dispatcher API (security)

Upcoming Versions

Version 1.1.0 (Planned - Q2 2026)

Features:

• Sandbox environment

• Additional webhook support (Invoicing, Email events)

• Batch dispatch endpoint

• Enhanced error messages

• GraphQL API (beta)

New Providers:

• Stripe Invoicing

• DocuSign (eSign)

• Twilio (SMS)

Version 2.0.0 (Planned - Q4 2026)

Breaking Changes:

• JWT format change (new claims structure)

• Provider config schema updates

• Webhook payload restructuring

Features:

• Multi-region support

• Enhanced analytics and reporting

• Template versioning API

• Advanced workflow orchestration

Breaking Changes

How We Handle Breaking Changes

1. Advance Notice: Breaking changes announced 90 days before release

2. Migration Guide: Detailed upgrade guides provided

3. Deprecation Period: Old endpoints supported for 6 months after new version

4. Version Header: Use X-API-Version header to opt into new versions

Example:

X-API-Version: 2.0

Deprecation Policy

Current Deprecations

None.

Deprecation Timeline

When an endpoint or feature is deprecated:

1. T+0: Deprecation announced in changelog

2. T+90 days: Warning headers added to responses

3. T+180 days: Endpoint removed or behavior changes

Deprecation Warning Header:

X-Deprecation-Warning: This endpoint is deprecated. Migrate to /api/v2/invoicing by 2026-08-13.

Provider Updates

Current Provider Versions

Provider	API Version	Last Updated	Status
iPaidThat	v1	2026-01-15	✅ Stable
Qonto	v2	2026-02-01	✅ Stable
PennyLane	v1	2025-12-10	✅ Stable
SuperPDP	v1	2026-01-20	✅ Stable
Universign	v1	2025-11-05	✅ Stable
Signaturit	v3	2026-01-30	✅ Stable
Yousign	v2	2025-12-15	✅ Stable
MySendingBox	v1	2026-02-05	✅ Stable
Brevo	v3	2026-01-10	✅ Stable
OVH	v1	2025-10-20	✅ Stable
SMS Factor	v1	2025-09-15	✅ Stable
SMS Magic	v1	2025-08-30	✅ Stable

Provider Deprecations

None currently.

SDK Versions

Node.js SDK

• Current: v1.0.0

• Minimum Node.js: v18.0.0

• TypeScript: ✅ Included

PHP SDK

• Current: v1.0.0

• Minimum PHP: v8.1

• Composer: ✅ Available

Java SDK

• Current: v1.0.0

• Minimum Java: v11

• Maven: ✅ Available

Migration Guides

From Direct Printer-API to Dispatcher

If you were previously using printer-api directly:

Before (printer-api):

POST https://printer-api.docs-dispatcher.io/documents/generate

After (Dispatcher):

POST https://api.docs-dispatcher.io/api/file

Full migration guide

Release Notes Format

Each release includes:

1. Version Number: Semantic versioning (MAJOR.MINOR.PATCH)

2. Release Date: ISO 8601 format

3. Features: New capabilities

4. Bug Fixes: Issues resolved

5. Breaking Changes: Incompatible changes

6. Deprecations: Features marked for removal

7. Migration Guide: How to upgrade

Staying Updated

Subscribe to Updates

• Email: Subscribe at https://docs-dispatcher.io/changelog

• RSS Feed: https://docs-dispatcher.io/changelog.rss (TBD)

• GitHub: Watch releases at github.com/docs-dispatcher/api (TBD)

Changelog in API Responses

All API responses include version headers:

X-API-Version: 1.0.0
X-API-Released: 2026-02-13

Versioning Strategy

We follow Semantic Versioning:

• MAJOR (1.x.x): Breaking changes, incompatible API updates

• MINOR (x.1.x): New features, backward-compatible

• PATCH (x.x.1): Bug fixes, backward-compatible

Example:

• 1.0.0 → 1.0.1: Bug fix (safe to upgrade)

• 1.0.0 → 1.1.0: New features (safe to upgrade)

• 1.0.0 → 2.0.0: Breaking changes (migration required)

Feedback

Found an issue or have a feature request?

• GitHub Issues: github.com/docs-dispatcher/api/issues (TBD)

• Support Email: [email protected]

• Feature Requests: https://feedback.docs-dispatcher.io (TBD)