Integrating digital resources and capabilities into other systems using HTTP APIs is commonplace in any enterprise. However, the experience, skills, time, and cost required for successful integrations can vary significantly depending on the API. This variability has driven companies to centralize their API efforts and adopt an 'API-as-a-product' approach—making integrations more seamless, efficient, and cost-effective. The API integration experience begins with onboarding but is also shaped by factors such as the availability and quality of SDKs, the ease of use within low-code or no-code platforms, and the initial design of the API itself. By fine-tuning these aspects, organizations can reduce friction, better meet the needs of API consumers, and ensure API resources and capabilities are readily accessible where and when they are needed.
Integration
Policies
Arazzo Workflows Provided
Require that APIs which chain multiple operations to accomplish real work provide Arazzo workflow definitions describing those sequences. I want the multi-step paths a consumer must follow, the ord...
Async Webhooks (Design)
Require that any API delivering events to consumers describes its webhooks as first-class citizens in the contract, using the OpenAPI webhooks object to define the payloads, headers, and callbacks ...
Hypermedia (Design)
Require that APIs return links alongside their data where it helps consumers navigate related resources, discover available actions, and follow state transitions without hardcoding URLs. APIs shoul...
Long Running Operations (Design)
Require that operations which cannot complete within a normal request window be modeled explicitly as asynchronous, long-running jobs rather than being forced into a single blocking call that ties ...
Event Types Cataloged
I require that every event an API emits is enumerated in a published catalog of event types, each with a stable name, a described payload, and a clear meaning, so consumers know exactly what can ha...
MCP Server Provided
I require that an API of consequence exposes a Model Context Protocol server so that agents can discover its capabilities and invoke them through a standard, well-understood interface rather than a...
Webhook Contracts Defined
I require that every webhook an API sends is described by a real contract that specifies its trigger, its payload, its headers, and its delivery and retry behavior, so integrators can build against...
Strategies
APIs Expose an MCP Server
I want our APIs to meet agents where they already are by exposing a Model Context Protocol server that turns our operations into tools an agent can pick up and use without a custom integration for ...
APIs Provide Orchestration Workflows
I want our APIs to ship the workflows, not just the endpoints, because most real jobs take more than a single call and I would rather hand consumers a proven path than make them assemble one from s...
APIs Use the Right Protocol for the Job
I want us to stop treating REST as the answer to every problem and instead pick the protocol that actually fits the job in front of us. When the interaction is event-driven we describe it with Asyn...
