Getting Started Overview

This section provides a high level overview of the steps required to integrate with the Digital Post Platform and send digital messages using the APIs.

It is intended for developers who are implementing system to system integrations for message delivery.

Detailed technical instructions are provided in the individual sections referenced below.

A typical integration enables an external system to:

• Authenticate using certificate based machine authentication
• Use S3 Upload Method: upload message content to object storage, then create and submit delivery requests
• Use Direct Multipart Submission: create and submit delivery requests with envelope and content files in the request
• Monitor processing and delivery status
• Handle errors and retries

The platform supports incremental adoption. Integrations may start with basic delivery and expand over time.

A standard integration follows these steps:

1. Obtain access to the platform and required permissions
2. Configure certificate based authentication
3. Prepare message content and metadata
4. Upload content to storage (if using S3 Upload Method)
5. Create and submit a delivery request
6. Monitor delivery status
7. Handle errors and renew authentication tokens

Each step is described in detail in the sections below.

Before starting an integration, and in order to enable sending messages , the following components must be available:

• An organisation account
• One or more sender identities
• A system integration with registered certificate
• Access to an S3 compatible storage service (required only for S3 Upload Method)
• API endpoint URLs for the target environment

These prerequisites are described in Prerequisites and Access.

All API access requires machine to machine authentication using client certificates and JWT based token exchange.

Authentication includes:

• Certificate registration
• JWT creation
• Token exchange
• Token renewal

Detailed instructions are provided in Authentication Setup.

Messages are prepared using envelope files that define:

• Sender identity
• Recipients
• Message metadata
• References to content files
• Optional message features

Envelope creation is described in Prepare Your First Message.

All message bodies and attachments must be uploaded to storage before delivery is initiated (if using S3 Upload Method).

Delivery requests reference the storage location containing envelope and content files.

The platform validates and processes all envelopes in a delivery.

The platform retrieves content from storage during processing.

Content upload is described in Upload Content to S3.

S3 delivery submission is described in Send Messages via S3 Delivery.

When using direct multipart submission, envelope files, body files, and attachments are submitted directly in one API request.

Multipart delivery submission is documented in Send Messages via Multipart.

After submission, integrations must monitor delivery processing and handle failures.

Verification includes:

• Checking delivery reports
• Tracking envelope status
• Implementing retries
• Handling permanent failures

Verification is described in Verify and Troubleshoot.

Message content may be encrypted before upload using AES 256.

If encryption is used, encryption keys must be provided during delivery.

Encryption is described in Encrypting Content (Optional).

For first time integrations, the following order is recommended:

1. Prerequisites and Access
2. Authentication Setup
3. Prepare Your First Message
4. Choose a Submission Method
5. Upload Content to S3
6. Send Messages via Multipart
7. Verify and Troubleshoot
8. Encrypting Content (Optional)

To begin implementation, start with:

Prerequisites and Access

This section explains how to obtain access, configure accounts, and prepare required identifiers.