Integration
Connect a message system over mutual TLS and exchange packages through the access point’s private Interface C API.
The private Interface C package API exchanges XHE packages with the message system. The public AS4 listener exchanges those messages with peer access points.
Connect the message system
Section titled “Connect the message system”Connect to the private listener using the tenant's client certificate and an internal bearer token. For the Docker installation, set served_participants in installation.json. The installer passes these identifiers to the runtime as AP_SERVED_PARTICIPANTS. Configure an instance
| Request | Result |
|---|---|
POST /transport/packages |
Submit the original XHE package as the request body with an Idempotency-Key. HTTP 202 returns X-Transport-Id and X-Transport-State. |
GET /transport/status/{transport-id} |
HTTP 200 returns X-Transport-State and X-Attempts. When a receipt is present, the response also includes X-Receipt-Id, X-Receipt-Type and X-Receipt-At. |
GET /transport/packages |
Retrieve a package and its X-Delivery-Id, or HTTP 204 when the inbox is empty. |
POST /transport/packages/acknowledgements |
Send the returned X-Delivery-Id with an empty body. HTTP 200 acknowledges retrieval. The same delivery can be returned until acknowledged. |
Handle errors and repeat delivery
Section titled “Handle errors and repeat delivery”Send the original XHE envelope as the request body. The package API applies a 100 MiB (104,857,600-byte) limit per envelope and checks its schema and routing metadata. An end-to-end encrypted payload stays opaque through the access point.
| Response | Client action |
|---|---|
401 |
Check API authentication and the tenant credentials. |
404 |
Check the API path, tenant and identifier. Access to another tenant’s state is reported as unknown. |
405 |
Use the documented HTTP method. |
422 |
Correct the rejected request or envelope before retrying. |
503 |
Reconcile status using the original IDs and retry the same request when the service recovers. |
Keep the idempotency key stable for the same submission. On the receiving side, use X-Delivery-Id to recognize repeated retrieval of the same delivery. The access point deduplicates inbound AS4 transport by tenant, sender and AS4 message ID. The application can use the XHE identifier to deduplicate business processing across distinct AS4 transfers.
Verify a test exchange
Section titled “Verify a test exchange”- Submit a synthetic XHE package and retain the transport ID returned by the access point. Reuse the same idempotency key if you retry the same submission.
- Query the transport status until it shows a verified AS4 receipt. At the receiving end, retrieve the package through the peer’s private API.
- Acknowledge retrieval once your receiving application has stored the package. Use the same
X-Delivery-Idto recognize repeat deliveries before acknowledgement.
Digg publishes the profiles for AS4 and message content. Check the profiles for the environment you intend to join. SDK and Digg references
Interpret acknowledgements
Section titled “Interpret acknowledgements”| Signal | What it confirms |
|---|---|
| HTTP 202 on submission | This access point accepted the package for transport. Use the transport ID to check progress. |
| Verified signed AS4 receipt | The peer access point acknowledged the AS4 transfer. |
| Business acknowledgement | A participating message system sent a separate application response. |
| Retrieval acknowledgement | The local message system confirmed retrieval of an inbound package from its access point. |