API Resources
Learn about API Resources you can publish as a Data Provider within a Trust Framework.
API Resources are essential in any Raidiam Connect ecosystem, defining the endpoints supported by a Data Provider. Proper registration of these resources is crucial for enabling third-party applications to discover and access the data an organization wants to share.
Different ecosystems or federations in Raidiam Connect may require Data Providers to publish various types of API Resources, such as:
- Data APIs
- Consent APIs
- Public APIs
- Authorisation Server APIs
- and more.
The required API Resources can also vary across different Authorization Domains within an ecosystem or federation. For instance, a Trust Framework might have domains for both Open Finance and Open Health initiatives, each with distinct requirements:
- Open Finance would require APIs related to accounts, payments, and more.
- Open Health would require APIs related to the user's health information.
Raidiam Connect allows Trust Framework Administrators to configure and define standardized API profiles. This standardization simplifies the integration process for Data Receivers, as they only need to adjust the API base URL when interacting with different Data Providers within the ecosystem or federation. The endpoints themselves remain consistent across various organizations, facilitating easier and more efficient data integration.
Raidiam Connect features built-in API discovery capabilities. This allows Data Providers to quickly define endpoints based on the API definitions configured by the Trust Framework Administrator. Organization administrators simply need to set the base URL for their APIs, and the available endpoints will be automatically defined according to the chosen API Family and Version. This streamlines the process and ensures consistency across the ecosystem.
Currently, Raidiam Connect allows organisations to publish their API resources only if an Authorisation Server is already configured within an organisation. This ensures that the necessary integration with the server to get access tokens is available, preventing situations where APIs would be inaccessible due to missing tokens.