Skip to content
MirrorFirm

What integration contract should we agree before a pilot is generated?

An agreed portability contract defines serialization, identifiers and adapter responsibilities so a generated pilot can enter the buyer's runtime without silent changes to meaning.

Agree the import contract before generating a pilot. Specify whether snapshots arrive as JSONL, Parquet or another supported representation, and provide schemas for required fields. Define how absent, unknown and explicitly empty values differ; an unknown contact preference should not silently become permission to use any channel.

Set identifier rules and reference handling. An adapter should preserve stable record identifiers or produce a mapping table when its runtime requires new keys. It should reject broken references rather than creating placeholder records that change the task.

Define timestamp precision, timezone handling and decimal representation where balances are included. These choices affect business meaning even when the imported values look superficially similar. Request validation fixtures that exercise the agreed conversions.

For environment lifecycle integration, specify an `initialise` operation that returns the imported episode identity and a reset operation that restores the same baseline. The buyer can supply its tool interface, while the proposed delivery describes the adapter boundary. This makes compatibility a concrete pilot acceptance question without assuming that every runtime or schema variation will be supported.

Resolve representation choices early to preserve business semantics across generation, import and execution.

Audience:
Environment builders
Content type:
Integration
Buyer question:
Scope and getting started

Content release: r-a220eb6e099b243b

More on Overdue follow up