User Guide 101 for Platform Providers
*** Note: This guide is still work in progress. ***
Please refrain from making any significant design/implementation decisions based on the points marked with ’tbc’ or ’tbd'.
- This guide is intended to provide support to the ‘Platform Providers’, i.e., the users who want to connect/integrate/federate their digital platform with the EFPF ecosystem.
- In the context of the EFPF ecosystem, the definition of a digital platform is “A platform that provides offerings such as digital tools, services and data, and secures access to them using its own Identity and Access Management service”.
- If you want to integrate a collection of tools and services with the ecosystem that do not have an associated Identity Provider, then refer to the User Guide 101 for Tool/Service/Data Providers.
Prerequisite: Setting up your EFPF User Account
- To perform/test out many of the following integration steps, an EFPF user account is necessary.
- You can find the instructions for setting up your EFPF user account here.
A new platform can be integrated with the EFPF ecosystem by using the following “Ecosystem Enablers”:
1. Data Spine: EFPF Security Portal (EFS): Enabling Single Sign-On (SSO) Functionality
- Integrating/connecting/federating a platform (which has its own private Identity Provider) with the EFPF Ecosystem means making its tools and services accessible with a single set of EFPF credentials, i.e., enabling the users of EFPF ecosystem to access the tools and services of that platform with their EFPF (EFS) user account.
- The EFS acts as the central Identity Provider for the EFPF ecosystem. It federates the identity providers of all platforms in the EFPF ecosystem in order to enable SSO functionality.
- Refer to the EFS SSO documentation to federate your platform’s Identity Provider with the EFS
- Details: EFS Overview, EFS SSO Guide With Keycloak, EFS SSO Guide With Non Keycloak IdPs
- Enabling SSO for the platform mainly enables two functionalities:
- Login with EFPF: These actions would enable SSO and add ‘Login with EFPF’ option to the login page of the integrated platform
- Access to Service APIs: These actions also enable access to the APIs of the tools/services in the platform with (authorized) EFPF user accounts
2. EFPF Portal (tbc)
- The EFPF Portal acts as the single point of entry for the EFPF ecosystem.
- An entry with platform’s name, logo, short description, etc., can be added to the ‘Platforms’ page of the EFPF Portal.
- The ‘Value Proposition’ pages can be updated.
- Details: EFPF Portal Documentation – link to be updated
3. EFPF Marketplace (tbc)
- The EFPF Marketplace retrieves the list of products and services from the marketplace services of the connected platforms and displays them coherently.
- After SSO is enabled for the platform, its marketplace service can be integrated with the EFPF ecosystem’s Marketplace.
- Details: EFPF Marketplace Documentation – link to be updated
4. Accountancy Service
Accountancy Service integration:
- The Accountancy Service aims to track and trace a user’s journey across the EFPF ecosystem and collect data about the transactions they make on different marketplaces to enable a cashback mechanism
- The Logstash endpoint of the Accountancy Service should be available through the Data Spine Service Registry
- Details: Accountancy Service Overview, Accountancy Service Integration Guide
- This is NOT in the scope of the Open Call experiments
5. Matchmaking/Federated Search (tbc)
Matchmaking/Federated Search integration:
- The goal of Matchmaking in the EFPF ecosystem is to facilitate EFPF users to find the best suited suppliers and enable them to transact with them efficiently and effectively.
- The Federated Search functionality enables search for products and services across the connected platforms, by using custom, user-defined search filters.
- The metadata of the newly connected platform’s participants (suppliers/service providers) & their value-units (products/services) can be added to the Matchmaking service’s index.
- Details: Matchmaking Service Overview, Matchmaking Service Integration Guide
6. Data Spine: Registration of Services / APIs
Data Spine Service Registry integration
- The technical metadata of the Services and their APIs (OpenAPI/Swagger/AsyncAPI specs) can then be registered to the Data Spine Service Registry, so that the potential service consumers can discover these services and retrieve their technical metadata such as the API endpoints, the API specs, etc., which are needed for consuming them directly or through the integration flows in Data Spine NiFi.
- Details: Service Registry Overview, Service Registry User Guide
Use of other Ecosystem Enablers
- The use of other Ecosystem Enablers such as the Data Spine (DS) Integration Flow Engine (DS NiFi), DS Message Bus (DS RabbitMQ), and DS API Security Gateway (DS APISIX) depends upon use cases involving service-level integration/communication.
- More details can be found in the following guides: