API & Integration

General material on integrating systems through contracts.

4Questions
15Flashcards
13Terms
Terminology

13 terms in this topic

case-study

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…

pattern

API Gateway

A single entry point in front of a set of services that handles authentication, rate limiting, routing and protocol translation.

concept

Backward Compatibility

The property that a new version of a producer continues to work with clients written against the old version.

practice

Enterprise Integration Patterns

A catalogue of named, composable messaging patterns — router, translator, aggregator, splitter, filter, dead letter channel — that gives integration …

protocol

GraphQL

A query language and runtime where the client specifies exactly which fields it needs, against a typed schema, usually via a single endpoint.

protocol

gRPC

A contract-first RPC framework using Protocol Buffers over HTTP/2, with generated clients and servers and first-class streaming.

pattern

Idempotency 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-study

LinkedIn 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…

tool

OpenAPI

A machine-readable specification format for HTTP APIs, from which documentation, clients, servers, mocks and validation can be generated.

pattern

Rate Limiting

Bounding how many requests a caller may make in a window, to protect capacity and enforce fair use.

protocol

REST

An architectural style for APIs built on resources identified by URLs, manipulated with uniform HTTP methods, and stateless requests.

case-study

Stripe'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…

pattern

Webhook

An HTTP callback from a provider to a consumer-supplied URL when an event occurs, replacing polling with push.

API & Integration Architecture

Neighbouring topics

REST Design

Resources, uniform methods, status codes and statelessness.

4 quiz 7 cards 3 terms

GraphQL

Client-specified queries, N+1 resolution and query-cost control.

4 quiz 9 cards 4 terms

gRPC APIs

Contract-first RPC, generated clients and protobuf compatibility rules.

3 quiz 8 cards 3 terms

Webhooks

Push callbacks, signature verification, ordering and at-least-once delivery.

5 quiz 12 cards 7 terms

API Versioning

URL, header and account-pinned versioning, and who carries the burden.

5 quiz 9 cards 5 terms

Backward Compatibility

Which changes are safe, and how to make breakage a build failure.

3 quiz 6 cards 3 terms

Contract Testing

Verifying what consumers actually rely on, without a shared environment.

5 quiz 12 cards 2 terms

API Documentation

OpenAPI as a machine-checked contract rather than as prose.

4 quiz 5 cards 2 terms

Rate Limiting

Algorithms, shared counters, and signalling rejection properly.

4 quiz 12 cards 4 terms

Idempotency Keys

Client-generated keys stored atomically with the operation they guard.

5 quiz 7 cards 3 terms

Pagination & Filtering

Offset versus cursor, stable ordering and unbounded result sets.

4 quiz 7 cards 3 terms

API Error Handling

Error shapes, retryability signals and machine-readable causes.

3 quiz 11 cards 4 terms

Event-Driven Integration

Publishing facts rather than commands, and versioning event schemas.

4 quiz 11 cards 5 terms

Message Formats

JSON, Protobuf, Avro — schema evolution and payload economics.

3 quiz 8 cards 2 terms

Schema Registry

Enforcing compatibility on events the way CI enforces it on code.

2 quiz 7 cards 4 terms

Integration Patterns

Routers, translators, splitters, aggregators and dead letter channels.

3 quiz 8 cards 6 terms

Legacy Integration

Reaching systems that cannot change, without importing their model.

4 quiz 11 cards 3 terms

Partner & B2B Integration

External contracts, onboarding, sandboxes and long deprecation windows.

4 quiz 9 cards 3 terms

APIs as Products

Ownership, lifecycle, deprecation policy and developer experience.

5 quiz 12 cards 3 terms