The PDF Generation service is hosted within the Non Repudiation Store infrastructure and is available to backend MDTP microservices via Private Link.

The detailed API specification is documented in Confluence with an abbreviated version below

• Version
• Generate PDF
• Ping

This endpoint returns the deployed version designation of this service

GET /generate-pdf/version

Sample response:

{
    "version": "20201118T150059"
}

This endpoint provides a mechanism whereby a calling service can specify a template to be populated with the matching JSON from the request body. These will be used to prepare PDF which will then be digitally signed and returned to the calling service

POST /generate-pdf/template/{template-id}/signed-pdf

An example template-id is trusts-5mld-1-0-0 which corresponds to the below configuration:

{
    template-id = "trusts-5mld-1-0-0"
    json-schema = "API#1584_Response_Schema-v1.0.0.json"
    pdf-template = "trusts-5mld.dito"
    signing-profile = "pades-t"
    api-key = "<...>"
}

The request body should be compliant with the schema associated with the selected {template-id}. An example request based on the API#1584_Response_Schema-v1.0.0.json schema referenced in the above configuration is 1584_control_1.0.0.json

This endpoint can be used as a lightweight health check for the availability of the service

GET /generate-pdf/ping

Returns "pong"

This code is open source software licensed under the Apache 2.0 License.