Skip to content

API and integration platform

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.
Vertical API & Integration
Prototype reference API & Integration prototype (ConnectSoft.DesignPrototypes)
Managed edition Managed (D33, D34)
Data residency tenant-region (D31)
Catalog Examples catalog · Vision-to-Production path for this vertical

Business problem

Partners integrate through bespoke endpoints and shared secrets; nobody knows what calls what.

Product intent

A partner API product: gateway, API products and keys, webhooks with signatures and replay, and a developer portal.

What the Factory makes different here: built from the Factory's own gateway and integration patterns (GW-06 and GW-07) as product features.

Vision-to-Production path for this vertical

Step Factory platform Agents Blueprints
Vision and product plan Agent Mesh, Control plane API Designer Agent, Integration Architect Agent vision
Architecture and domain Template & Library (BC-02) Enterprise Architect Agent service, module, api-gateway, integration, security
Experience Template & Library, Factory Studio UX track UX Designer Agent, Frontend Developer Agent —
Recipe and generation Template & Library (BC-15), Agent Mesh, Tools & MCP API Designer Agent, Integration Architect Agent, Security Architect Agent, Backend Developer Agent, Documentation Writer Agent module plan from the context map
Quality Observability (BC-22), DevOps / GitOps QA Agent documentation, test
Delivery and provisioning DevOps / GitOps (BC-23, BC-24), Runtime Cloud (BC-25) DevOps Agent, Infrastructure Architect Agent —
Operations Product Fleet Operations (BC-35..37) — handover, objectives, rollouts, incidents, off-boarding

Delivery workflows exercised: enterprise-and-system-architecture-workflows, documentation-and-knowledge-management-workflows.

Generated product shape

C4Context
    title API and integration platform system context
    Person(user, "Users", "API & Integration users and operators")
    System_Ext(factory, "ConnectSoft AI Factory", "generates, delivers, provisions and operates the product")
    System_Boundary(product, "API and integration platform") {
        System(ctx_ApiProducts, "ApiProducts", "products, plans, keys")
        System(ctx_Webhooks, "Webhooks", "subscriptions, deliveries, replay")
        System(ctx_Portal, "Portal", "docs, sandbox, analytics")
    }
    Rel(user, ctx_ApiProducts, "uses through the product gateway GW-07")
    Rel(factory, ctx_ApiProducts, "descriptor, health, rollouts, incidents, off-boarding")
Hold "Alt" / "Option" to enable pan & zoom

Bounded contexts

Context Responsibility Published events
ApiProducts products, plans, keys KeyIssued
Webhooks subscriptions, deliveries, replay DeliveryDispatched
Portal docs, sandbox, analytics AppRegistered

Modules and templates

Module Template Notes
API gateway connectsoft-apigateway
Microservice ×3 connectsoft-microservice
Developer portal connectsoft-blazor-shell
Docs site connectsoft-documentation
Every product also gets the SaaS foundations (tenants, editions, entitlements, billing, metering) and the product host shape (descriptor, health, operations handover) unless it is a library-only product.

Prototype reference

API & Integration prototype in ConnectSoft.DesignPrototypes shows the intended screens; the UX track (U1–U4) maps prototype destinations to the UX model's screens with keep, merge, rename, retire or new decisions.

Operations as a managed product

Managed; partner keys rotated through the secret pattern.