E-services

A part containing general information, which includes essential details on how the e-service functions.

A versioned part, managed through progressive automatic versioning; it contains data that are subject to change and evolve over time.

Name and short description: displayed within the E-service Catalog on PDND.

Technology: the technology used to develop the API through which the e-service will be provided, either REST or SOAP.

Mode: whether the e-service handles data in read or write. If it writes, it means the producer receives data; if it reads, all endpoints return data to the subscriber. It is not possible to have a single e-service expose both read and write endpoints.

Risk analysis: required only for services operating in write mode. In that case, the producer must indicate the use cases for which they plan to collect consumer data and complete the risk analysis questionnaire. More details are available in the dedicated section.

Delegation authorization: indicates whether consuming Public Administrations can delegate another Public Administration to complete administrative tasks (service request, purpose) on their behalf. More details in the dedicated section.

Presence of data change notification (Signal Hub): indicates whether this e-service is integrated with the Signal Hub, enabling consumers to stay updated on changes to data of interest within the producer’s database. If disabled, the involved parties cannot write or read notifications via the Signal Hub. More details in the dedicated guide.

API specification file for this e-service version: must upload an OpenAPI file for REST services or a WSDL file for SOAP services, as indicated within the security perimeter of the ModI. This file contains the interface specification of the API the producer will expose in this version of the e-service.

Additional technical documentation: the producer may attach supporting documentation for the API specification, such as a usage manual or examples. This is always recommended.

Changelog (version description): a brief summary highlighting changes from the previous version(s).

Attributes: list of access requirements the consumer must possess to have their service request activated and access the producer’s e-service. More details in the dedicated section.

Policy for activating service requests: by default, all service requests submitted by consumers are automatically activated if they possess all required access requirements; the producer may choose to activate them manually instead.

API call thresholds: the expected load in API calls/day that the producer’s infrastructure can handle. More details in the dedicated section describing the load estimation mechanism.

Voucher validity duration: time period for which the voucher issued by PDND remains valid to access the service.

Audience parameter (aud): a standard claim representing the resource for which the request is authorized (e.g., a URL or unique identifier). The producer will receive this value in the voucher provided to the consumer by PDND.