Table of contents
API overview
PDND Interoperability makes a REST API available, which permits all the CRUD operations necessary for managing the information to be stored.
The API is part of the Interoperability APIs and it can be accessed after obtaining a valid voucher related to an Interop API client.
The system permits managing traces only for your own institution. The identification of the caller by PDND Interoperability takes place using the information contained in the voucher (token JWT) included in the header of the call, according to standard PDND standard patterns.
Management of the information
The system allows members to manage the sending of CSV files containing information related to the transactions carried out. After receiving the single file, the system proceeds with CSV validation.
If there are no errors, the system processes the data, adding additional details and saves the individual records.
Should there be any warnings, the upload is considered valid. A warning identifies a row containing a purpose_id that is valid within PDND but cannot be associated with the provider or consumer identified by the record.
Otherwise, the errors can be checked and fixed. Or, if necessary, the previously entered data can be updated.
Integration via OpenAPI
The system is designed to integrate services via OpenAPI.
Offered services
| Method | Endpoint | Description |
|---|---|---|
| POST | /tracings/submit | Submission of a trace for a day. Returns the tracingId of that trace |
| GET | /tracings | List of traces for the requesting institution |
| GET | /tracings/{tracingId}/errors | Detail of the errors or warnings contained in a single trace |
| POST | /tracings/{tracingId}/recover | Recovery of the information in a trace that has errors or missing data |
| POST | /tracings/{tracingId}/replace | Complete replacement of the data of a previously uploaded trace |
OpenAPI specification
The OpenAPI specification of the tracing API is available at the following address.
