Skip to content

Consumption and/or provision of data services

Data service consumption

On ADEL, each institution that has joined ADEL decides for itself whether another ADEL member can consume its data services. The ADEL member providing the data service is responsible for granting and managing access.

If an ADEL member wants to start requesting data, for example, from a commercial register data service, the consuming member must contact the State Register of Legal Entities Agency of the RA Ministry of Justice.

Prerequisites

  • You have deployed X-Road Security Server and a subsystem is registered in it.
  • You have found the X-Road subsystem or specific data services that you want to consume in the ADEL service catalog.

Data service provision

Providing a data service means adding a data service description or REST endpoint to a subsystem in the X-Road security server. This helps create a connection between the subsystem and the application endpoints, where the security server can direct the incoming request.

Prerequisites

  • You have deployed X-Road Security Server and a subsystem is registered in it.
  • Your security server can communicate with the application server at the network level (definitely on port 443 in production).

Adding a data service on the security server

1․ Log in to your security server's management interface (on port 4000) and open the detailed view of your subsystem.

2․ Select Services.

3․ To add a REST service:

  • Click Add REST.
  • Choose whether to include a reference to the OpenApi3 description in the URL line or have the URL line point directly to the REST API.
  • Enter the corresponding address in the URL line (the security server must have network access to the address).
  • Enter the Service Code value on the next line. You can come up with this value yourself and it is the service identifier.
  • Click Add.

4․ To add a SOAP service:

  • Click Add WSDL.
  • In the URL line, you need to enter the URL of the server from which the SOAP service WSDL file is available (the security server must have network access to the address).
  • Once the URL is entered, click Add.

5․ To enable an added service, click the button on the right side of the service line in the Services view.

Adding clients to the data service and managing access

Before granting access to another ADEL member, a data service usage agreement must be concluded with them, on the basis of which data exchange will take place.

1․ Log in to your security server's management interface (on port 4000) and open the detailed view of your subsystem.

2․ Select Service Clients. This displays the ADEL members or global groups that have been granted access to data services within this subsystem.

3․ Click Add Subject.

4․ Filter and select the ADEL member subsystem to which you want to grant access to the data service.

5․ In the next view, select the data service(s) you want to grant access to the selected subsystem.

6․ Click Add.

Access is now granted and the other ADEL member can now query the data service through the subsystem selected in step 4.