Glossary of technical terms
This section provides definitions for key terms used within ApiShare, ensuring clarity and a common understanding of terminology related to API governance and lifecycle management.
Administrators
Alias: Admins
Refers to users with administrative privileges, including Tenant Owners, Organization Admins, Group Admins, and any custom role with administrative permissions.
API
An Application Programming Interface (API) is a mechanism that allows two software applications to communicate. In ApiShare, APIs fall into two categories:
Enterprise Asset: A backend service such as a REST API, SOAP service, JDBC connection, or Kafka topic that enables software integration.
Digital Product: A standardized version of an API Asset designed for modern application integration and partner connectivity.
API Gateway
Alias: API GW, GW
A component that acts as an entry point for API traffic, handling request routing, authentication, rate limiting, and logging.
API Governance
A set of policies and best practices that ensure APIs are developed, secured, and managed in a consistent and efficient manner.
API Guidelines
Alias: Guidelines
A structured framework of rules for API design, covering topics like authentication, endpoint naming, error handling, and versioning.
APP (Application)
Alias: Application
A software entity that either produces APIs (Provider) or consumes APIs (Consumer). Applications can belong to one or more groups within an organization.
Asset
Alias: API Asset
A technical representation of an enterprise integration that provides valuable resources such as data or functionalities. API Assets serve as the foundation for Digital Products.
Deployment Pipeline
Alias: Pipeline
A structured process that automates the building, testing, and deployment of APIs across different environments (DEV, TEST, PROD).
Developer
Alias: Dev
A user responsible for the technical implementation of an API or application.
Ecosystem
Alias: API Ecosystem
Represents the entire API governance framework in ApiShare, including organizations, groups, APIs, and applications.
Enterprise Integration
Alias: EI
The process of connecting business applications and services using APIs to enable seamless data flow and operational efficiency.
Environment Domain
Alias: Env domain, Application domain, APP domain
A logical grouping that defines the scope in which APIs and applications operate, such as Development, Testing, or Production environments.
Group
A structural unit within an organization that houses users, APIs, and applications, allowing for governance and access control.
Operational Model
Alias: Operative Model
Defines how APIs are developed, deployed, monitored, and retired within an organization's governance framework.
Organization
Alias: Org
The highest-level governance entity in ApiShare, representing business units or external partners. Organizations contain multiple groups and define API visibility and ownership.
Owner
The designated business owner of an API or application, responsible for its functional and strategic management.
Product (API Product)
Alias: Digital Product, API Product
An exposed API that is published for external use through an API Gateway.
Provider
Alias: [APP] Producer
The Application that exposes an API, making it available for consumption.
Subscription
Alias: Subs
A contractual relationship between an application (consumer) and an API (provider), defining the terms of API access.
Tenant
A self-contained instance of ApiShare used by a specific organization. Each tenant maintains independent data, settings, and user permissions.
Use Case
A specific scenario in which an API is utilized to address a business need, such as mobile integration or third-party connectivity.
Workspace
A user’s working environment within ApiShare, where administrative and API management tasks are performed.