API & Integration
General material on integrating systems through contracts.
4 to work through
-
intermediate Multiple choice
You are designing APIs for a platform with a web app, a mobile app, internal service-to-service traffic and third-party partners. What do you expose, and where?
2 min answer -
advanced
A multi-product SaaS company exposes REST APIs, webhooks, an app marketplace, OAuth-scoped integrations and embedded plugins. Which integration surface creates the most long-term architectural constraint, and why?
2 min answer -
advanced
An authentication provider's API is on the critical path of thousands of applications. What does that dependency position demand architecturally?
2 min answer -
advanced
You run a communications API of Twilio's shape, whose customers' businesses stop when you are degraded. An enterprise customer wants a contractual per-endpoint p99 latency SLA written into their renewal. Walk me through your answer.
3 min answer
13 terms in this topic
Amazon 2002: The API Mandate
A directive that all teams expose functionality only through service interfaces, with no back doors, is widely credited with making both Amazon's arc…
patternAPI Gateway
A single entry point in front of a set of services that handles authentication, rate limiting, routing and protocol translation.
conceptBackward Compatibility
The property that a new version of a producer continues to work with clients written against the old version.
practiceEnterprise Integration Patterns
A catalogue of named, composable messaging patterns — router, translator, aggregator, splitter, filter, dead letter channel — that gives integration …
protocolGraphQL
A query language and runtime where the client specifies exactly which fields it needs, against a typed schema, usually via a single endpoint.
protocolgRPC
A contract-first RPC framework using Protocol Buffers over HTTP/2, with generated clients and servers and first-class streaming.
patternIdempotency Key
A client-generated unique value sent with a request so the server can recognise a retry and return the original result instead of acting twice.
case-studyLinkedIn and the Origin of Kafka
Kafka was built to replace point-to-point data integration between many systems with a single durable log that any system could publish to and any nu…
toolOpenAPI
A machine-readable specification format for HTTP APIs, from which documentation, clients, servers, mocks and validation can be generated.
patternRate Limiting
Bounding how many requests a caller may make in a window, to protect capacity and enforce fair use.
protocolREST
An architectural style for APIs built on resources identified by URLs, manipulated with uniform HTTP methods, and stateless requests.
case-studyStripe's API Versioning
Stripe pins each account to the API version current when it integrated and transforms requests and responses between versions internally, so integrat…
patternWebhook
An HTTP callback from a provider to a consumer-supplied URL when an event occurs, replacing polling with push.
Neighbouring topics
REST Design
Resources, uniform methods, status codes and statelessness.
GraphQL
Client-specified queries, N+1 resolution and query-cost control.
gRPC APIs
Contract-first RPC, generated clients and protobuf compatibility rules.
Webhooks
Push callbacks, signature verification, ordering and at-least-once delivery.
API Versioning
URL, header and account-pinned versioning, and who carries the burden.
Backward Compatibility
Which changes are safe, and how to make breakage a build failure.
Contract Testing
Verifying what consumers actually rely on, without a shared environment.
API Documentation
OpenAPI as a machine-checked contract rather than as prose.
Rate Limiting
Algorithms, shared counters, and signalling rejection properly.
Idempotency Keys
Client-generated keys stored atomically with the operation they guard.
Pagination & Filtering
Offset versus cursor, stable ordering and unbounded result sets.
API Error Handling
Error shapes, retryability signals and machine-readable causes.
Event-Driven Integration
Publishing facts rather than commands, and versioning event schemas.
Message Formats
JSON, Protobuf, Avro — schema evolution and payload economics.
Schema Registry
Enforcing compatibility on events the way CI enforces it on code.
Integration Patterns
Routers, translators, splitters, aggregators and dead letter channels.
Legacy Integration
Reaching systems that cannot change, without importing their model.
Partner & B2B Integration
External contracts, onboarding, sandboxes and long deprecation windows.
APIs as Products
Ownership, lifecycle, deprecation policy and developer experience.