User Guide 101 for Tool/Service Consumers
This guide is designed to provide support to Tool/Service Consumers, that is, the users who want to consume a tool/service that is already present in the EFPF Ecosystem.
The GUIs of many tools/services are already integrated into the EFPF Portal so they can be accessed directly through the Portal (e.g., using the Matchmaking services’s GUI in order to search for suppliers). This only requires setting up an account. This guide offers information in case you want to access the APIs of tools/services programmatically.
An overall flowchart of the steps is illustrated in the following picture:
Setting up your account
Setting up an account is the same for all types of users, so you can find the instructions here.
Consume a tool/service
Set up your EFPF account: Setting up an account is the same for all types of users, so you can find the instructions here.
Get an access token via the EFPF Security Portal API: You need to first get a token from the EFS Keycloak that you later will use to access the Service Registry (Latest example: EFPF API Security Gateway User Guide). While invoking Service Registry’s API, you would need to pass the access token using ‘Authorization’ header as explained in the documentation.
Retrieve the needed information from the Service Registry: Use the Service Registry API to search for the existing services you want to use and retrieve the needed data. The URL of the Service Registry can be found here. (Details: Service Registry Overview, Service Registry User Guide)
Data Transformation needed?: If you expect data adhering to a different data model than what the tool/service provides, you can make use of Data Spine (DS) NiFi to create an integration flow (i.e., a workflow/dataflow) that uses the built-in data model transformation tools (e.g., Jolt, XSLT, ExecuteScript, etc.). NiFi provides an intuitive drag-and-drop GUI to create integration flows easily. Follow these steps in the User Guide 101 for Composite Application Developer).
Consume the Tool/Service: Now, you can consume the service directly by calling the Service Provider’s API endpoint or by the API endpoint at which the transformed data is available, depending upon the previous step. The information you got from the Service Registry should be enough to allow you to consume the service, since it provides the technical metadata such as the API specification.
EFPF Ecosystem Documentation
- Data Spine User Guide: This guide enlists the activities that the service consumers need to do in order to consume the services provided through the Data Spine with the help of examples.