Description of the software interfaces
Overview
This page contains a description of the different software interfaces created for the DE4A project. The information provided can be used as a reference on the development and integration process to each pilot.
Interfaces availables
| Component | Iteration | Pattern | Service | Referenced API | Interface type | Communication | Input message | Output |
|---|---|---|---|---|---|---|---|---|
| Data Evaluator | 1, 2 | USI | Forward evidence | /requestForwardEvidence | XML REST | Synchronous | RequestForwardEvidenceType | ACK |
| 2 | User redirection | /usiRedirectUser | XML REST | Synchronous | RedirectUserType | ACK | ||
| 1 | Request user redirection | /requestUserRedirection | XML REST | Synchronous | RequestUserRedirectionType | HTTP Status 302 | ||
| Data Owner | 1, 2 | IM | Extract evidence IM | /requestExtractEvidenceIM | XML REST | Synchronous | RequestExtractEvidence | ResponseExtractEvidenceType |
| 1, 2 | USI | Extract evidence USI | /requestExtractEvidenceUSI | XML REST | Synchronous | RequestExtractEvidence | ResponseErrorType | |
| 2 | User redirection | /usiRedirectUser | XML REST | Synchronous | RedirectUserType | ResponseErrorType | ||
| 1 | ResponseUserRedirection | /responseUserRedirection | XML REST | Synchronous | ResponseUserRedirectionType | HTTP Status 302 | ||
| Data Requestor (Connector) | 1, 2 | - | Lookup Rounting Information | /lookupRountingInformation | XML REST | Synchronous | RequestLookupRoutingInformationType | ResponseLookupRoutingInformationType |
| 1, 2 | IM | Request transfer evidence | /requestTransferEvidenceIM | XML REST | Synchronous | RequestTransferEvidenceType | ResponseTransferEvidenceType | |
| 1, 2 | USI | Request transfer evidence USI | /requestTransferEvidenceUSI | XML REST | Asynchronous | RequestTransferEvidenceType | ResponseErrorType | |
| Data Transferor (Connector) | 1, 2 | USI | Response transfer evidence USI | /requestTransferEvidenceUSIDT | XML REST | Synchronous | RequestTransferEvidenceUSIDTType | ACK |
SMP/SML
The Service Metadata Locator (SML) is a singleton instance in the DE4A network. It is operated by CEF, a key facility of the European Commission, and provided to the DE4A project. DE4A is currently operating on the test instance of the SML, called “SMK”, and was assigned the DNS zone de4a.acc.edelivery.tech.ec.europa.eu. for the project.
The task of a Service Metadata Publisher (SMP) is to create the link between the technical identifiers and the effective endpoint URL to exchange messages with. Additionally, it provides X.509 certificates that will be used to encrypt messages for a specific receiver. Each participant has a list of so called “Endpoints” that are uniquely identified by a combination of a document type identifier, a process identifier and a transport profile. An SMP makes it possible for two parties in the domain to exchange documents with dynamic discovery and utilizing the 4 Corner Model used for eDelivery within the DE4A project.
In the case of DE4A project, the Connector handles the interaction with the "service metadata resources", there are two function modes depending of the configuration in the Connector:
Establishing a certain SMP
- The Connector will request all the services information to the SMP configured.
Without SMP definition
- The Connector will request to the SML in order to get the SMP location which contains services information for the certain participant given.
The requests to the SMP/SML components are performed using the peppol-commons (by Phax) libraries, based on the CEF Specifications:
AS4 Gateway
The Connector includes an implementation of an AS4 gateway called phase4 by using:
Based on the specifications: