Skip to content

Documentation Overview

This section explains how the Digital Post Platform is structured, how digital messages are processed, and how different platform components interact.

It is intended for developers and technical integrators who need to understand platform concepts, workflows, and operational models in order to design, implement, and maintain reliable integrations.

While the Getting Started section focuses on completing a first integration, this section focuses on understanding how the platform works.


Purpose of This Section

The Documentation section provides:

  • Conceptual explanations of platform architecture
  • Descriptions of core domain models
  • Message delivery and processing workflows
  • Identity and recipient resolution concepts
  • Security and encryption principles
  • Error handling and retry behavior
  • Reporting and audit mechanisms

This information supports long term integration design, troubleshooting, and optimization.


Intended Audience

This documentation is intended for:

  • Developers integrating sender systems with the platform
  • Technical architects designing integration solutions
  • Platform holder developers building custom frontends
  • Technical support and operations teams

It assumes familiarity with:

  • REST based APIs
  • Authentication and authorization mechanisms
  • Object storage systems
  • Message based integration patterns

Scope

This section covers platform behavior at a conceptual and technical level.

It includes:

  • Organisational structure and governance model
  • Sender identity management concepts
  • Message submission and delivery models
  • Recipient identification mechanisms
  • Message lifecycle stages
  • Optional security and encryption models
  • Delivery guarantees and limitations

It does not include:

  • Administrative procedures
  • Commercial terms
  • Operational policies
  • Market specific configurations
  • User interface instructions

Where relevant, links to external administrative documentation are provided.


How to Use This Section

Readers are encouraged to review this section before implementing advanced integrations.

Typical usage patterns include:

  • Reviewing the organisational model before onboarding senders
  • Understanding delivery behavior before batching messages
  • Studying lifecycle stages before implementing status polling
  • Reviewing security concepts before enabling client side encryption

Each page can be read independently, but together they describe the complete operational model of the platform.


Structure of This Section

The Documentation section is organized into the following main topics:


Relationship to Other Sections

This section complements other parts of the documentation:

Getting Started

Getting Started provides step by step guidance for first time integrations.

API Reference

API Reference provides detailed endpoint specifications, parameters, and schemas.

Developers are encouraged to use all sections together for a complete understanding.


Terminology and Consistency

All terms in this section follow the definitions in the platform glossary.

Key terms such as:

  • Platform holder
  • Organisation account
  • Sender identity
  • Receiver

are used consistently throughout the documentation.

No alternative terminology is introduced.


Change Management

This documentation is maintained alongside platform releases.

When platform behavior changes:

  • Conceptual descriptions are updated
  • Related sections are revised
  • Deprecated behaviors are documented

Integrators should review this section regularly to remain aligned with platform updates.


Next Steps

To begin exploring platform concepts, start with:

These pages provide the foundation for all other documentation.