Integration Guides

Publish searchable, version-pinned task blueprints that connect multiple endpoint contracts into safe business workflows without conflating narrative composition with executable authority.

BUSINESS CASES

Where this module fits

workflow implementation
security-profile adoption
cross-module orchestration
failure and reconciliation design
business-case discovery

PRIMARY CONSUMERS

Who integrates it

solution architects
integration teams
workflow and planning agents
security and operations reviewers

PREREQUISITES

What must exist first

a defined business outcome and acceptance policy
access to every required implemented module and scope
an OpenAPI-aware consumer that can distinguish implemented and planned registry statuses

RECOMMENDED WORKFLOW

Compose the module safely.

01
search by exact category and bounded content query
02
select a stable guide slug and retain the returned source digest
03
resolve every related endpoint against live OpenAPI
04
exclude planned-only operations or design explicit future-state boundaries
05
implement controls, retries, verification, reconciliation, and rollback
06
revalidate all referenced contracts before release

MODULE CONTRACTS

Every mapped endpoint

Each operation states whether its request shape is authoritative in OpenAPI, reviewed as a planning profile, or intentionally left as an outline pending an owner schema.

GETList integration guides/api/v2/integration-guidesList published implementation blueprints by product, industry, use case, and maturity.›GETGet integration guide/api/v2/integration-guides/{guide_slug}Return one versioned integration blueprint and its linked endpoint contracts.›