Boomi API Management study materials
Boomi API Management study resources

Boomi API Management key terms

Boomi API Management · Get comfortable with the vocabulary.

API Gateway

A runtime component that receives client calls, enforces policies such as authentication and rate limiting, and forwards approved traffic to the backing service.

Related: API Proxy, Policy Enforcement, Rate Limiting
API Proxy

A managed endpoint layer that fronts an existing backend service, exposing it under a controlled URL while applying security, throttling, and transformation rules.

Related: API Gateway, Backend Service, API Definition
API Definition

A machine-readable description of an API's endpoints, operations, parameters, and schemas, used to generate documentation and enforce contracts.

Related: OpenAPI Specification, API Proxy, Contract Testing
OpenAPI Specification

A vendor-neutral standard format for describing REST APIs in JSON or YAML so tooling can validate, document, and generate clients consistently.

Related: API Definition, Contract Testing, API Documentation
API Documentation

Human-readable reference material describing how to call an API, including endpoints, authentication, request examples, error codes, and usage guidance for developers.

Related: OpenAPI Specification, Developer Portal, API Product
Developer Portal

A self-service website where external or internal developers discover APIs, read documentation, request access, manage credentials, and monitor their own usage.

Related: API Product, API Documentation, API Key
API Versioning

A scheme for releasing incompatible API changes without breaking existing consumers, typically through URL paths, headers, or parallel published versions.

Related: Backward Compatibility, API Definition, Deprecation
Deprecation

The formal process of announcing that an API version or operation will be retired, including timelines and migration guidance for affected consumers.

Related: API Versioning, Sunset Policy, Consumer
Rate Limiting

A control that caps how many requests a client may send in a time window, protecting backend capacity and ensuring fair use across consumers.

Related: Throttling, Quota, API Gateway
Throttling

Deliberately slowing or rejecting excess traffic when limits are exceeded, often returning a retry-after signal so clients can back off gracefully.

Related: Rate Limiting, Quota, Backend Service
Quota

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.

Related: Rate Limiting, API Plan, Consumer
API Plan

A named bundle of access rights and limits, such as rate caps and available operations, that consumers subscribe to when requesting an API product.

Related: API Product, Quota, Subscription
API Product

A packaged offering that groups one or more APIs with plans, documentation, and policies so target audiences can discover and subscribe to them.

Related: API Plan, Developer Portal, Subscription
Subscription

The recorded agreement granting a specific application access to an API product under a chosen plan, usually tied to credentials and approval status.

Related: API Plan, API Key, Consumer
Consumer

A person, team, or application that calls an API and therefore depends on its contract, credentials, limits, and published lifecycle commitments.

Related: Subscription, API Key, Developer Portal
API Key

A simple credential identifying a calling application, used mainly for identification and basic access control rather than strong user authentication.

Related: OAuth 2.0, Subscription, Credential Rotation
OAuth 2.0

An authorization framework that issues scoped access tokens to applications acting on behalf of users or themselves, without sharing underlying passwords.

Related: Access Token, Scope, API Key
Access Token

A time-limited credential presented with API requests to prove granted authorization; it is validated by the gateway before the call proceeds.

Related: OAuth 2.0, Scope, Token Expiration
Scope

A named permission attached to a token that restricts which operations or resources the bearer may access, enabling least-privilege authorization.

Related: Access Token, OAuth 2.0, Least Privilege
Token Expiration

The defined lifetime after which an access token becomes invalid and must be refreshed or reissued, limiting damage from leaked credentials.

Related: Access Token, Refresh Token, Credential Rotation
Refresh Token

A longer-lived credential used to obtain new access tokens without requiring the user to sign in again, and which can be revoked independently.

Related: Access Token, Token Expiration, OAuth 2.0
Mutual TLS

A transport security mode where both client and server present certificates, letting the gateway verify the caller's identity at the connection level.

Related: TLS, Certificate, API Gateway
TLS

The cryptographic protocol that encrypts data in transit between clients and API endpoints, preventing eavesdropping and tampering on the network.

Related: Mutual TLS, Certificate, Transport Security
Certificate

A signed digital document binding a public key to an identity, used to prove server authenticity or, in mutual authentication, client identity.

Related: TLS, Mutual TLS, Certificate Rotation
Credential Rotation

The scheduled replacement of keys, secrets, or certificates to reduce exposure from stale or leaked credentials, usually automated with overlap periods.

Related: API Key, Certificate Rotation, Secret Management
Secret Management

Practices and tooling for storing, distributing, and auditing sensitive values such as client secrets and private keys outside source code and plain configuration.

Related: Credential Rotation, API Key, Least Privilege
Least Privilege

The principle of granting only the permissions needed for a task, minimizing the blast radius if a credential or component is compromised.

Related: Scope, Role-Based Access Control, Secret Management
Role-Based Access Control

An authorization model assigning permissions to roles rather than individuals, so users inherit capabilities based on their organizational function.

Related: Least Privilege, Scope, Policy Enforcement
Policy Enforcement

Applying governance or security rules at runtime, such as rejecting noncompliant calls, transforming payloads, or logging traffic centrally.

Related: API Gateway, Governance Policy, Rate Limiting
Governance Policy

A reusable rule that defines required behavior for APIs, for example mandatory authentication, naming conventions, or approved deployment environments.

Related: Policy Enforcement, API Linting, Compliance
API Linting

Automated static checks against a specification to catch style, security, and design violations before an API is published to consumers.

Related: Governance Policy, OpenAPI Specification, Compliance
Design Review

A structured peer assessment of a proposed API contract before build, checking consistency, usability, and alignment with organizational standards.

Related: API Linting, Governance Policy, API Definition
Compliance

Demonstrable adherence to internal standards and external regulations, evidenced through audits, logs, and enforced controls across the API lifecycle.

Related: Governance Policy, Audit Trail, Policy Enforcement
Audit Trail

A chronological record of who changed or accessed what, supporting investigations, regulatory evidence, and accountability for API configuration changes.

Related: Compliance, Logging, Policy Enforcement
Logging

Capturing request, response, and error details from API traffic so operators can troubleshoot failures and analyze usage patterns.

Related: Audit Trail, Monitoring, Observability
Monitoring

Continuous tracking of health and performance signals, such as latency and error rates, to detect degradation and trigger operational responses.

Related: Logging, Observability, Service Level Agreement
Observability

The ability to understand internal system state from external outputs like metrics, logs, and traces, enabling diagnosis of complex distributed failures.

Related: Monitoring, Logging, Audit Trail
Service Level Agreement

A documented commitment about availability, latency, or support response, defining measurable targets and consequences when the API misses them.

Related: Monitoring, API Product, Consumer