Description of the software interfaces - Revision history

Philip.helger at 11:41, 4 October 2022

2022-10-04T11:41:59Z

Philip.helger at 11:29, 4 October 2022

2022-10-04T11:29:16Z

Mpttfp ismael.magdaleno: Minor typo

2022-02-23T12:53:47Z

Minor typo

Antonio.osuna at 15:05, 22 February 2022

2022-02-22T15:05:01Z

Antonio.osuna at 14:56, 22 February 2022

2022-02-22T14:56:40Z

Antonio.osuna: /* AS4 Gateway */

2022-02-22T12:54:59Z

AS4 Gateway

Javier.ferrero: /* Interfaces availables */ Quality checks.

2022-02-21T16:41:18Z

Interfaces availables: Quality checks.

Antonio.osuna at 12:35, 7 February 2022

2022-02-07T12:35:01Z

Antonio.osuna at 07:25, 7 February 2022

2022-02-07T07:25:10Z

Antonio.osuna at 07:24, 7 February 2022

2022-02-07T07:24:00Z

@@ Line 3: / Line 3: @@
 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.
-This page is only relevant for '''Iteration 1'''
+This page is only relevant for '''Iteration 1'''. The respective list for Iteration 2 can be found at [[Summary of software interfaces.]]
 == Available interfaces ==

@@ Line 2: / Line 2: @@
 [[Category:wip]]
 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.
 == Available interfaces ==

@@ Line 57: / Line 57: @@
 | rowspan="3" |Data Requestor (Connector)
 | [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI]
-|Lookup Rounting Information
+|Lookup Routing Information
 |/lookupRountingInformation
 |XML REST

@@ Line 8: / Line 8: @@
 !Component
 !Pattern
 !Service
 !Referenced API
@@ Line 22: / Line 21: @@
 |XML REST
 |Synchronous
-|RequestForwardEvidenceType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L567 RequestForwardEvidenceType]
-|ACK
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 |-
 |Response user redirection
@@ Line 29: / Line 28: @@
 |XML REST
 |Synchronous
-|ResponseUserRedirectionType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L601 ResponseUserRedirectionType]
 |HTTP Status 302/303 (Http/1 Http/2)
 |-
@@ Line 38: / Line 37: @@
 |XML REST
 |Synchronous
-|RequestExtractEvidence
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L523 RequestExtractEvidenceIMType]
-|ResponseExtractEvidenceType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L537 ResponseExtractEvidenceType]
 |-
 | rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI]
@@ Line 46: / Line 45: @@
 |XML REST
 |Synchronous
-|RequestExtractEvidence
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L509 RequestExtractEvidenceUSIType]
-|ResponseErrorType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
 |-
 |RequestUserRedirection
@@ Line 53: / Line 52: @@
 |XML REST
 |Synchronous
-|RequestUserRedirectionType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L595 RequestUserRedirectionType]
-|HTTP Status 302
+|HTTP Status 302/303 (Http/1 Http/2)
 |-
 | rowspan="3" |Data Requestor (Connector)
@@ Line 62: / Line 61: @@
 |XML REST
 |Synchronous
-|RequestLookupRoutingInformationType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L580 RequestLookupRoutingInformationType]
-|ResponseLookupRoutingInformationType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L589 ResponseLookupRoutingInformationType]
 |-
 |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM]
@@ Line 70: / Line 69: @@
 |XML REST
 |Synchronous
-|RequestTransferEvidenceType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType]
-|ResponseTransferEvidenceType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L546 ResponseTransferEvidenceType]
 |-
 |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI]
@@ Line 78: / Line 77: @@
 |XML REST
 |Asynchronous
-|RequestTransferEvidenceType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType]
-|ResponseErrorType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
 |-
 |Data Transferor (Connector)
@@ Line 87: / Line 86: @@
 |XML REST
 |Synchronous
-|RequestTransferEvidenceUSIDTType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L477 RequestTransferEvidenceUSIDTType]
-|ResponseErrorType
+|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
 |}

@@ Line 5: / Line 5: @@
 == Available interfaces ==
 {| class="wikitable"
-|+DE4A Components interfaces description
+|+DE4A Components interfaces description (Iteration 1)
 !Component
 !Pattern
 !Service
 !Referenced API
@@ Line 16: / Line 16: @@
 !Output
 |-
-| rowspan="3" |Data Evaluator
+| rowspan="2" |Data Evaluator
-|1, 2
+| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI]
 |Forward evidence
 |/requestForwardEvidence
@@ Line 26: / Line 25: @@
 |ACK
 |-
 |Response user redirection
 |/responseUserRedirection
@@ Line 42: / Line 32: @@
 |HTTP Status 302/303 (Http/1 Http/2)
 |-
-| rowspan="4" |Data Owner
+| rowspan="3" |Data Owner
-|1, 2
+|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT-DO1-IM.xsd IM]
 |Extract evidence IM
 |/requestExtractEvidenceIM
@@ Line 52: / Line 41: @@
 |ResponseExtractEvidenceType
 |-
-|1, 2
+| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI]
 |Extract evidence USI
 |/requestExtractEvidenceUSI
@@ Line 61: / Line 49: @@
 |ResponseErrorType
 |-
 |RequestUserRedirection
 |/requestUserRedirection
@@ Line 78: / Line 57: @@
 |-
 | rowspan="3" |Data Requestor (Connector)
-|1, 2
+| [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI]
 |Lookup Rounting Information
 |/lookupRountingInformation
@@ Line 87: / Line 65: @@
 |ResponseLookupRoutingInformationType
 |-
-|1, 2
+|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM]
 |Request transfer evidence
 |/requestTransferEvidenceIM
@@ Line 96: / Line 73: @@
 |ResponseTransferEvidenceType
 |-
-|1, 2
+|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI]
 |Request transfer evidence USI
 |/requestTransferEvidenceUSI
@@ Line 106: / Line 82: @@
 |-
 |Data Transferor (Connector)
-|1, 2
+|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI]
 |Response transfer evidence USI
 |/requestTransferEvidenceUSIDT

← Older revision		Revision as of 12:54, 22 February 2022
Line 115:		Line 115:
	\|ResponseErrorType		\|ResponseErrorType
	\|}		\|}
−
−	~~== 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 [https://github.com/phax/peppol-commons peppol-commons] ''(by Phax'') libraries, based on the CEF Specifications:~~
−
−	* [https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+BDXL eDelivery BDXL]
−	* [https://oasis-open.org/committees/tc_home.php?wg_abbrev=bdxr OASIS BDXR]
−
−	~~== AS4 Gateway ==~~
−	~~The Connector includes an implementation of an AS4 gateway ('''phase4''') using the following third-party libraries and components:~~
−
−	* [https://github.com/TOOP4EU/toop-connector-ng Toop Connector NG]
−	* [https://github.com/phax/phase4 phax/phase4 libraries]
−
−	~~Based on the specifications:~~
−
−	* [https://ec.europa.eu/cefdigital/wiki/display/CEFDIGITAL/eDelivery+AS4+-+1.14 eDelivery AS4]
−	* [https://docs.peppol.eu/edelivery/as4/specification/ PEPPOL AS4 Profile]

@@ Line 1: / Line 1: @@
 [[Category:WP5]]
 [[Category:wip]]
 == Interfaces availables ==