Boomi API Management key terms
Boomi API Management · Get comfortable with the vocabulary.
- API Gateway
- Related: API Proxy, Policy Enforcement, Rate Limiting
A runtime component that receives client calls, enforces policies such as authentication and rate limiting, and forwards approved traffic to the backing service.
- API Proxy
- Related: API Gateway, Backend Service, API Definition
A managed endpoint layer that fronts an existing backend service, exposing it under a controlled URL while applying security, throttling, and transformation rules.
- API Definition
- Related: OpenAPI Specification, API Proxy, Contract Testing
A machine-readable description of an API's endpoints, operations, parameters, and schemas, used to generate documentation and enforce contracts.
- OpenAPI Specification
- Related: API Definition, Contract Testing, API Documentation
A vendor-neutral standard format for describing REST APIs in JSON or YAML so tooling can validate, document, and generate clients consistently.
- API Documentation
- Related: OpenAPI Specification, Developer Portal, API Product
Human-readable reference material describing how to call an API, including endpoints, authentication, request examples, error codes, and usage guidance for developers.
- Developer Portal
- Related: API Product, API Documentation, API Key
A self-service website where external or internal developers discover APIs, read documentation, request access, manage credentials, and monitor their own usage.
- API Versioning
- Related: Backward Compatibility, API Definition, Deprecation
A scheme for releasing incompatible API changes without breaking existing consumers, typically through URL paths, headers, or parallel published versions.
- Deprecation
- Related: API Versioning, Sunset Policy, Consumer
The formal process of announcing that an API version or operation will be retired, including timelines and migration guidance for affected consumers.
- Rate Limiting
- Related: Throttling, Quota, API Gateway
A control that caps how many requests a client may send in a time window, protecting backend capacity and ensuring fair use across consumers.
- Throttling
- Related: Rate Limiting, Quota, Backend Service
Deliberately slowing or rejecting excess traffic when limits are exceeded, often returning a retry-after signal so clients can back off gracefully.
- Quota
- Related: Rate Limiting, API Plan, Consumer
A cumulative usage allowance assigned to a consumer over a longer period, such as daily or monthly call counts, distinct from short-term rate limits.
- API Plan
- Related: API Product, Quota, Subscription
A named bundle of access rights and limits, such as rate caps and available operations, that consumers subscribe to when requesting an API product.
- API Product
- Related: API Plan, Developer Portal, Subscription
A packaged offering that groups one or more APIs with plans, documentation, and policies so target audiences can discover and subscribe to them.
- Subscription
- Related: API Plan, API Key, Consumer
The recorded agreement granting a specific application access to an API product under a chosen plan, usually tied to credentials and approval status.
- Consumer
- Related: Subscription, API Key, Developer Portal
A person, team, or application that calls an API and therefore depends on its contract, credentials, limits, and published lifecycle commitments.
- API Key
- Related: OAuth 2.0, Subscription, Credential Rotation
A simple credential identifying a calling application, used mainly for identification and basic access control rather than strong user authentication.
- OAuth 2.0
- Related: Access Token, Scope, API Key
An authorization framework that issues scoped access tokens to applications acting on behalf of users or themselves, without sharing underlying passwords.
- Access Token
- Related: OAuth 2.0, Scope, Token Expiration
A time-limited credential presented with API requests to prove granted authorization; it is validated by the gateway before the call proceeds.
- Scope
- Related: Access Token, OAuth 2.0, Least Privilege
A named permission attached to a token that restricts which operations or resources the bearer may access, enabling least-privilege authorization.
- Token Expiration
- Related: Access Token, Refresh Token, Credential Rotation
The defined lifetime after which an access token becomes invalid and must be refreshed or reissued, limiting damage from leaked credentials.
- Refresh Token
- Related: Access Token, Token Expiration, OAuth 2.0
A longer-lived credential used to obtain new access tokens without requiring the user to sign in again, and which can be revoked independently.
- Mutual TLS
- Related: TLS, Certificate, API Gateway
A transport security mode where both client and server present certificates, letting the gateway verify the caller's identity at the connection level.
- TLS
- Related: Mutual TLS, Certificate, Transport Security
The cryptographic protocol that encrypts data in transit between clients and API endpoints, preventing eavesdropping and tampering on the network.
- Certificate
- Related: TLS, Mutual TLS, Certificate Rotation
A signed digital document binding a public key to an identity, used to prove server authenticity or, in mutual authentication, client identity.
- Credential Rotation
- Related: API Key, Certificate Rotation, Secret Management
The scheduled replacement of keys, secrets, or certificates to reduce exposure from stale or leaked credentials, usually automated with overlap periods.
- Secret Management
- Related: Credential Rotation, API Key, Least Privilege
Practices and tooling for storing, distributing, and auditing sensitive values such as client secrets and private keys outside source code and plain configuration.
- Least Privilege
- Related: Scope, Role-Based Access Control, Secret Management
The principle of granting only the permissions needed for a task, minimizing the blast radius if a credential or component is compromised.
- Role-Based Access Control
- Related: Least Privilege, Scope, Policy Enforcement
An authorization model assigning permissions to roles rather than individuals, so users inherit capabilities based on their organizational function.
- Policy Enforcement
- Related: API Gateway, Governance Policy, Rate Limiting
Applying governance or security rules at runtime, such as rejecting noncompliant calls, transforming payloads, or logging traffic centrally.
- Governance Policy
- Related: Policy Enforcement, API Linting, Compliance
A reusable rule that defines required behavior for APIs, for example mandatory authentication, naming conventions, or approved deployment environments.
- API Linting
- Related: Governance Policy, OpenAPI Specification, Compliance
Automated static checks against a specification to catch style, security, and design violations before an API is published to consumers.
- Design Review
- Related: API Linting, Governance Policy, API Definition
A structured peer assessment of a proposed API contract before build, checking consistency, usability, and alignment with organizational standards.
- Compliance
- Related: Governance Policy, Audit Trail, Policy Enforcement
Demonstrable adherence to internal standards and external regulations, evidenced through audits, logs, and enforced controls across the API lifecycle.
- Audit Trail
- Related: Compliance, Logging, Policy Enforcement
A chronological record of who changed or accessed what, supporting investigations, regulatory evidence, and accountability for API configuration changes.
- Logging
- Related: Audit Trail, Monitoring, Observability
Capturing request, response, and error details from API traffic so operators can troubleshoot failures and analyze usage patterns.
- Monitoring
- Related: Logging, Observability, Service Level Agreement
Continuous tracking of health and performance signals, such as latency and error rates, to detect degradation and trigger operational responses.
- Observability
- Related: Monitoring, Logging, Audit Trail
The ability to understand internal system state from external outputs like metrics, logs, and traces, enabling diagnosis of complex distributed failures.
- Service Level Agreement
- Related: Monitoring, API Product, Consumer
A documented commitment about availability, latency, or support response, defining measurable targets and consequences when the API misses them.