{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting Started Overview","description":"Developer documentation for integrating systems that send messages, plus reporting and operational APIs for platform holders."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started-overview","__idx":0},"children":["Getting Started Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It is intended for developers who are implementing system to system integrations for message delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Detailed technical instructions are provided in the individual sections referenced below."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-scope","__idx":1},"children":["Integration Scope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A typical integration enables an external system to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authenticate using certificate based machine authentication"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use S3 Upload Method: upload message content to object storage, then create and submit delivery requests"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use Direct Multipart Submission: create and submit delivery requests with envelope and content files in the request"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Monitor processing and delivery status"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handle errors and retries"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The platform supports incremental adoption. Integrations may start with basic delivery and expand over time."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"high-level-integration-flow","__idx":2},"children":["High Level Integration Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A standard integration follows these steps:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Obtain access to the platform and required permissions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configure certificate based authentication"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Prepare message content and metadata"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Upload content to storage (if using S3 Upload Method)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create and submit a delivery request"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Monitor delivery status"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handle errors and renew authentication tokens"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each step is described in detail in the sections below."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-components","__idx":3},"children":["Required Components"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before starting an integration, and in order to enable sending messages , the following components must be available:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An organisation account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["One or more sender identities"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A system integration with registered certificate"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access to an S3 compatible storage service (required only for S3 Upload Method)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API endpoint URLs for the target environment"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These prerequisites are described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/prerequisites"},"children":["Prerequisites and Access"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication-setup","__idx":4},"children":["Authentication Setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API access requires machine to machine authentication using client certificates and JWT based token exchange."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authentication includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Certificate registration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["JWT creation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Token exchange"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Token renewal"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Detailed instructions are provided in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/authentication"},"children":["Authentication Setup"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"message-preparation","__idx":5},"children":["Message Preparation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Messages are prepared using envelope files that define:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sender identity"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recipients"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message metadata"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["References to content files"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optional message features"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Envelope creation is described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/prepare-message"},"children":["Prepare Your First Message"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"content-upload","__idx":6},"children":["Content Upload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All message bodies and attachments must be uploaded to storage before delivery is initiated (if using S3 Upload Method)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delivery requests reference the storage location containing envelope and content files."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The platform validates and processes all envelopes in a delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The platform retrieves content from storage during processing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Content upload is described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/upload-s3#s3-upload-rules"},"children":["Upload Content to S3"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["S3 delivery submission is described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/upload-s3"},"children":["Send Messages via S3 Delivery"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"direct-multipart-submission","__idx":7},"children":["Direct Multipart Submission"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using direct multipart submission, envelope files, body files, and attachments are submitted directly in one API request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Multipart delivery submission is documented in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/submit-multipart"},"children":["Send Messages via Multipart"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery-verification","__idx":8},"children":["Delivery Verification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After submission, integrations must monitor delivery processing and handle failures."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Verification includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Checking delivery reports"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tracking envelope status"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Implementing retries"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handling permanent failures"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Verification is described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/verify-delivery"},"children":["Verify and Troubleshoot"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"optional-encryption","__idx":9},"children":["Optional Encryption"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Message content may be encrypted before upload using AES 256."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If encryption is used, encryption keys must be provided during delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Encryption is described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/encryption"},"children":["Encrypting Content (Optional)"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recommended-reading-order","__idx":10},"children":["Recommended Reading Order"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For first time integrations, the following order is recommended:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/prerequisites"},"children":["Prerequisites and Access"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/authentication"},"children":["Authentication Setup"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/prepare-message"},"children":["Prepare Your First Message"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/choosesubmissionmethod"},"children":["Choose a Submission Method"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/upload-s3"},"children":["Upload Content to S3"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/submit-multipart"},"children":["Send Messages via Multipart"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/verify-delivery"},"children":["Verify and Troubleshoot"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/encryption"},"children":["Encrypting Content (Optional)"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":11},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To begin implementation, start with:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/prerequisites"},"children":["Prerequisites and Access"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section explains how to obtain access, configure accounts, and prepare required identifiers."]}]},"headings":[{"value":"Getting Started Overview","id":"getting-started-overview","depth":1},{"value":"Integration Scope","id":"integration-scope","depth":2},{"value":"High Level Integration Flow","id":"high-level-integration-flow","depth":2},{"value":"Required Components","id":"required-components","depth":2},{"value":"Authentication Setup","id":"authentication-setup","depth":2},{"value":"Message Preparation","id":"message-preparation","depth":2},{"value":"Content Upload","id":"content-upload","depth":2},{"value":"Direct Multipart Submission","id":"direct-multipart-submission","depth":2},{"value":"Delivery Verification","id":"delivery-verification","depth":2},{"value":"Optional Encryption","id":"optional-encryption","depth":2},{"value":"Recommended Reading Order","id":"recommended-reading-order","depth":2},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Getting Started Overview","description":"Overview of the steps required to integrate with the Digital Post Platform and send your first message.","seo":{"title":"Getting Started Overview"}},"lastModified":"2026-06-04T09:15:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/getting-started/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}