This documentation provides a comprehensive overview of our API, which allows for automated interaction with our platform.

The API is designed to streamline your workflow management and document processing.

To facilitate integration testing and ensure smooth adoption, the API is available in two environments: Acceptance (ACC) for validation and Production (PRO) for live operations.

The setup of credentials to make authenticated calls to the API is detailed in the dedicated page Authentication.

Without any additional configuration, you can immediately use the API to:

• Monitor the status of all your Jobs
• Monitor the status and the full track & trace of all the Sendings

To submit new jobs through the API:

1. Workflow Configuration (Prerequisite)

   • Configure your workflow(s) in the Web Platform
   • Define necessary tasks (ERDS channel, Email channel, Print & Send fallback, ...)
   • Obtain the workflow ID, which is required for job submission

2. Workflow Validation

   • Use the workflow endpoint to verify that your workflow is properly validated
   • Only validated workflows can be used for job submission

3. Document Submission

   • The submission is a two-step process:
     1. Call the prepare endpoint POST /jobs/single-file with required metadata. Upon a valid request, you will receive a response containing an upload URL fileUploadUrl.
     2. Upload your file (PDF document, or XML, CSV file depending on the workflow configuration) by performing an HTTPS PUT call on the URL fileUploadUrl embedding the file as a binary stream.

Example curl request on the fileUploadUrl: bash curl -X PUT -T "/path/to/file" "fileUploadUrl"

The complete API specification is available in OpenAPI format, accessible through the following link: OpenAPI Specification. This specification details all available endpoints, request/response formats, and authentication requirements.