Integration Platform — APIs

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.

ConnectorRegistryService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/factory/connectors	ListConnectors	factory.connections.read	read	natural	GW-03	Connector descriptors with capabilities, adapter versions, webhook schemes and certification state.
POST	/factory/connectors/{connectorId}/certify	CertifyConnector	factory.connections.admin	sandbox	key-header	GW-03	Run the conformance suite against a connection of this connector (sandbox action; evidence as artifact).
POST	/factory/subscriptions	CreateSubscription	factory.connections.admin	external	key-header	GW-03	Subscribe to provider events through a connection; creates the GW-06 ingress identity.
GET	/factory/deliveries	ListDeliveries	factory.connections.read	read	natural	GW-03	Deliveries by direction, connector, state and time with receipts.
POST	/factory/deliveries/{deliveryId}/replay	ReplayDelivery	factory.connections.operate	shared-write	natural	GW-03	Re-dispatch a failed inbound delivery from the stored payload (Operator).

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Connectors	Deliver	none	internal	external	Outbound delivery through a connector with the calling tool's policy decision and approval; returns the receipt.
Connectors	ResolveCapability	none	internal	read	Resolve a capability interface to the adapter and connection for a scope.

IntegrationHost

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/integration/health	IntegrationHealth	factory.health.read	read	natural	GW-01	Liveness, readiness and dependency health (store, secret broker, connector adapters, webhook ingress).
GET	/integration/meta/connectors	IntegrationAdapters	factory.meta.read	read	natural	GW-03	Connector adapters loaded in this host (first-party clients and generic HTTP, OpenAPI, MCP) with versions and capability interfaces.

IntegrationService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
POST	/factory/connections	RegisterConnection	factory.connections.admin	shared-write	key-header	GW-03	Register a connection with provider, endpoint policy, credential kind and a Key Vault reference (Workspace admin or Platform admin); the value is written to Key Vault by the caller or the Secret Broker flow, never posted here.
GET	/factory/connections	ListConnections	factory.connections.read	read	natural	GW-03	Connections in scope with provider, state, health, rotation due and grant counts.
POST	/factory/connections/{connectionId}/verify	VerifyConnection	factory.connections.admin	external	key-header	GW-03	Verify the credential through the Secret Broker and a provider health call (external class, read-only probe).
PUT	/factory/connections/{connectionId}/grants/{subjectKind}/{subjectId}	SetGrant	factory.connections.admin	shared-write	natural	GW-03	Grant or narrow a subject's use of the connection.
POST	/factory/connections/{connectionId}/rotate	RotateCredential	factory.connections.admin	production	key-header	GW-03	Record a rotation (new reference) and re-verify; production class because dependent systems are affected.
POST	/factory/connections/{connectionId}/revoke	RevokeConnection	factory.connections.admin	production	natural	GW-03	Revoke immediately; dependent sources, tools and servers stop.

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Connections	Resolve	none	internal	read	Resolve a connection for a subject with a grant check; returns endpoint policy and a broker ticket the caller exchanges for a short-lived credential.

WebhookGatewayService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
POST	/webhooks/{ingressRef}	ReceiveWebhook	factory.webhooks.receive	shared-write	key-header	GW-06	Vendor webhook endpoint per subscription ingress identity; verifies and captures, returns 202 or the rejection status.
GET	/webhooks/health	WebhookHealth	factory.health.read	read	natural	GW-06	Liveness and readiness of the ingress.