Term Kind Topic What it is
API Deprecation Policy practice APIs as Products The published commitment about how long a version is supported, how notice is given, and what consumers can expect — without which nothing is ever retired.
API Documentation practice API Documentation Documentation as part of the product surface — where quality determines adoption more than the API's technical design does.
API Error Design Problem Details, RFC 9457 practice API Error Handling Returning failures in a consistent machine-readable structure that tells a client what went wrong, whether to retry, and what to do about it.
API Product Management practice APIs as Products Treating an API as a product with a lifecycle — versioning, deprecation, adoption metrics and a support commitment — rather than as an implementation detail.
API Versioning Strategy practice API Versioning The scheme for introducing incompatible change, and the far more important question of how long old versions live and who pays to migrate.
B2B Integration practice Partner & B2B Integration Integrating with partner organisations, where the technical problem is small and the versioning, onboarding and support problems are large.
Bulk and Batch API Design practice REST Design Endpoints that accept many items in one call, and the partial-failure semantics that make them either useful or dangerous.
Capability Flag Partner Capability, Feature Declaration practice Integration Patterns Representing genuine differences between integrated partners as explicit declared capabilities, rather than as variant fields in a shared canonical model.
Contract Testing Consumer-Driven Contracts practice Contract Testing Verifying that a provider satisfies what its consumers actually depend on, without deploying both together.
Cursor Pagination Keyset Pagination, Seek Pagination practice Pagination & Filtering Paginating by encoding a position in a stable sort order rather than by numeric offset - constant cost per page and correct under concurrent modification.
Deletion Safety Threshold Mass-Delete Guard, Sync Blast Radius Limit practice Partner & B2B Integration A refusal to process a deletion batch above some proportion of the population without human confirmation - the control whose absence produces the most damaging incidents in synchronisation systems.
Delivery Attempt Log Webhook Delivery History practice Webhooks A customer-visible record of every outbound delivery attempt - its response, timing and payload - which converts a support burden into self-service.
Deprecation Brownout Sunset Rehearsal, Scheduled Dark Window practice Backward Compatibility An announced, time-boxed window in which a deprecated interface returns its retirement error, used to convert an abstract sunset date into a failure the consumer sees in their own monitoring.
Enterprise Integration Patterns EIP practice API & Integration A catalogue of named, composable messaging patterns — router, translator, aggregator, splitter, filter, dead letter channel — that gives integration work a shared vocabulary.
Event Versioning practice Event-Driven Integration Evolving event schemas without breaking consumers that may read messages written months earlier.
gRPC API Design practice gRPC APIs Designing service interfaces in a schema-first binary protocol — where the discipline differs from REST and where the mistakes are permanent.
Legacy Integration practice Legacy Integration Connecting modern services to systems that cannot be changed — where the constraints are as much commercial and operational as technical.
Pagination Design Cursor Pagination, Keyset Pagination practice Pagination & Filtering Returning large result sets in pages, where offset-based paging is both slow at depth and incorrect under concurrent writes.
Partner Onboarding practice Partner & B2B Integration The repeatable process by which an external organisation is connected, tested and moved to production — and a common hidden bottleneck.
Provider Capability Matrix Integration Support Grid, Honest Capability Declaration practice Integration Patterns An explicit per-provider record of which normalised capabilities are genuinely supported, which are approximated and which are unavailable - published as a product feature rather than kept as internal documentation.
Provider Verification practice Contract Testing The provider-side stage that replays every consumer's recorded expectations against the real implementation.
Query Cost Analysis Query Complexity Limiting, Cost-Based Rate Limiting practice GraphQL Computing the resource cost of a client-specified query before executing it, so that an API which lets clients define their own requests cannot be asked to do unbounded work.
Rate Limit Design Token Bucket, Sliding Window practice Rate Limiting The algorithm, scope and response behaviour that determine whether throttling protects the service and treats callers fairly.
Resource Modelling practice REST Design Expressing an API as nouns with a consistent hierarchy rather than as verbs, so URLs are predictable and methods carry the semantics.
Semantic Diffing of API Schemas practice Backward Compatibility Comparing the published contract between builds and failing the build on a breaking change, so compatibility is mechanical rather than remembered.
Semantic Versioning SemVer practice API Versioning A version scheme where the number itself states the compatibility promise — major for breaking, minor for additive, patch for fixes.
Spec-First Development Design-First practice API Documentation Writing and reviewing the API specification before implementing, so the contract is designed deliberately rather than emerging from code.
Webhook Reliability practice Webhooks The delivery, retry, ordering, verification and replay concerns that separate a production webhook system from a fire-and-forget HTTP POST.
Webhook Signature practice Webhooks An HMAC over the raw request body using a shared secret, letting a receiver verify a webhook genuinely came from the provider.