Core concepts & API governance
ApiShare operates within a structured governance framework that ensures clarity in the relationships between APIs, API Products, API Assets, Applications, Organizations, and Groups. These entities interact within a well-defined governance model that supports multi-tenancy, access control, and lifecycle management.
Core Entities in ApiShare
API Products & API Assets
ApiShare differentiates API between Products and Assets to provide flexibility in API governance:
API Products: Business-level APIs that are externally consumable and designed for application integration.
API Assets: Technical backend services that power API Products but are not directly exposed to external consumers.
API Products are often linked to one or more API Assets, which handle the actual execution of API requests.
Applications
Applications in ApiShare act as consumers or providers of APIs:
Consumer Applications: Subscribe to API Products to access their services.
Provider Applications: Expose APIs and manage API publishing within the platform.
Applications ensure governance rules are enforced while maintaining a structured subscription model.
Organizations and Groups
Organizations and Groups define how users interact with APIs and applications:
Organizations: Represent business units or external partners that manage APIs.
Groups: Allow for granular access control within an organization by assigning specific roles and permissions to users.
Entity Relationships
Relationships Between APIs, Products, and Applications
ApiShare maintains structured entity relationships that define API governance:
Entity
Relationships |
---|
Entity
Relationships | |
---|---|
API Products | Linked to API Assets, subscribed to by Applications. |
API Assets | Exposed by a Provider Application, provide backend functionality for API Products. |
Applications | Can be API consumers or providers. |
Organizations | Define API ownership and governance policies. |
Groups | Collect user with different roles and manage API access. |
These structured relationships ensure governance policies are enforced across all entities within ApiShare.