Sustema

D09

Integrate the supported release

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

Use the release-matched OpenAPI, field dictionary, error catalogue and binding information together. The documentation download must contain only released public data operations and their reachable schemas; private account, staff, operator and commercial interfaces are not a public SDK surface.

Elixir, Python and TypeScript have equal priority for core-task examples, documentation, tests and support under the equal-language delivery requirement. The retained plan names TypeScript and Python starters; the exact Elixir deliverable still needs engineering qualification. An importable API collection and MCP integration are also planned. They remain implementation/qualification work; this draft does not claim working packages or give invented installation commands. Each should demonstrate a successful first request, an ambiguous or insufficient-evidence result, a denied call, a safe retry and the usage receipt with the same release semantics.

Preserve wire strings, identifiers, conditional fields and errors. Validate the actual JSON mapping against the canonical release; do not weaken the contract to accommodate a generator or coerce values silently. A generated typed model is usable only after its positive and adverse cases pass. Contract validity does not prove real authentication, matching, accounting or provider access.

MCP exposes the same bounded data capabilities and recovery/accounting rules. Tool availability is not authority to buy services or change account policy. Check the exact released MCP endpoint, OAuth flow, client compatibility and generation before connecting an agent. Do not expose private administrative operations or use a shared operator credential.

Release notes must explain meaningful changes to coverage, rights, confidence, charging and recovery as well as JSON shape. Existing retained results remain bound to their supported generation and rights; do not assume that switching to the newest client makes old receipts equivalent.

Choose an integration path

Your immediate task Start here Before making a real call
Learn what a result means Read the result No account or network needed; its synthetic receipts are illustrative.
Test one permitted reference interactively First-request guidance Select the correct workspace, check the available profile and maximum usage, then submit deliberately.
Prepare application code Language examples and credentials Follow that release’s server-side OAuth setup and qualify its wire-value and recovery handling.
Inspect requests in an API client API collection guidance and availability Import into an authorised environment, inspect each request and supply credentials through the client’s protected local mechanism.
Let an authorised agent use data operations MCP guidance and availability Qualify the client/version, endpoint, OAuth audience, delegated scope and usage ceiling before invoking a tool.

Prepare application code

Start with the application credentials guide, then inspect the offline reader for your language. Each reader uses the same synthetic outcome JSON. The readers explain response handling; they do not authenticate, send API requests or provide an SDK.

Language Response-reading source Bundle-verification source
Elixir read_result.exs verify_bundle.exs
Python read_result.py verify_bundle.py
TypeScript read-result.ts verify-bundle.ts

Keep wire strings and identifiers intact in every language. Read the business outcome, evidence, limitations and receipt separately, and preserve conditional fields and the original error envelope. Use errors and recovery for denied calls and lost acknowledgements; retrying must retain the original operation identity.

The verifier sources are candidate offline examples. Read their limitations on the downloads page before using them. Released authenticated starters, installation instructions and supported runtime versions are not available here. A language reader or verifier does not establish authenticated integration or production readiness.

Bind the reference before making requests

Read capabilities first and retain the exact profile_id, profile revision and contract_binding. Obtain the immutable public bundle from the download location named by that documentation release. It contains the complete binding, OpenAPI, field dictionary and error catalogue, with the specified canonical byte artifacts. Verify the hashes using the bundle’s declared representation; a generic template’s file hash and a compiled profile’s canonical-content hash are different things.

A missing artifact, unknown binding or hash mismatch stops new work. Do not guess an endpoint or fall back to whatever schema a client generator happens to contain. Re-read capabilities and validate the replacement artifacts only through the supported compatibility path. Keep any unresolved original operation on its original key, creation time and compatible recovery contract.

Use the API reference to inspect the exact operation’s inputs, success and error branches, headers, rights and charge treatment. Start with capabilities and identity resolution, then follow the permitted entity, evidence, relationship or hierarchy references you need. Classification, operation status, receipt and usage pages have distinct authority and accounting rules. A navigation label is not an entitlement. Private account, staff, control and funding-purchase interfaces must not appear in this public reference or collection.

Use the collection deliberately

Import the collection distributed with the accepted release; do not use a historical draft merely because it imports successfully. Match its binding to the capabilities result. Keep environment values local and separate test from production. Never export an environment containing a token or secret with the collection.

For the first logical operation, record one key, its original creation time, the unchanged request and your explicit maximum units. Inspect the response, outcome and receipt before proceeding. If delivery times out, retain those values and follow D07; a collection script must not replace the key on retry. Running a folder or collection can invoke several operations: review their aggregate authority and usage before doing so. Importing or viewing a collection does not itself authorise those calls.

An executable API collection is not available from these pages. Its actual format, supported importer, release binding and authenticated behaviour must be qualified before a download is offered.

Connect an MCP client

Use only the released ENTITY endpoint and the documented OAuth flow for your client. Check its supported protocol and runtime versions and select the intended workspace and delegated data authority. The initial contract uses MCP 2025-11-25 over Streamable HTTP with JSON responses; it does not provide an SSE event stream. Complete initialization and compare the returned immutable binding with the release’s public bundle. Discovery lists the stable catalogue; it does not grant permission to invoke every tool.

Read the selected tool’s scope and effects before invoking it. Some operations consume delegated credits or change an owned order or report. No tool grants authority to buy funding, accept new account terms or expand a spending mandate. Preserve exact wire values and the full returned API envelope, including limitations and usage. Treat company and supplier text as data, never as agent instructions.

If an invocation loses its acknowledgement, reconcile the original operation. A later authentication failure says nothing about whether an earlier attempt committed. Reinitialising an expired session, sending notifications/cancelled, or deleting the MCP session does not cancel or refund admitted business work. Cancellation of delivery and cancellation of a supported owned classification order are separate operations.

An MCP connection is not available from these pages. Supported client versions, the actual endpoint and OAuth setup, generation readback, revocation, restricted disclosure, recovery and REST/MCP accounting parity still need end-to-end qualification.

Release acceptance for this documentation

An independent developer must be able to use the provided materials to complete and explain success, ambiguity, conflicting identifiers, unsupported scope, missing fields, rate/budget refusal, lost acknowledgement and retained-result restrictions. Record any assistance needed. Apply equivalent core cases to Elixir, Python and TypeScript and to the collection/MCP path where relevant. Offline reader tests cover only part of that evidence; they cannot close the authenticated first-use or release gates.

Inspect the offline TypeScript, Python and Elixir readers · Read the candidate API reference

Read the complete API collection guide, MCP guide and release compatibility guide.

Downloads and offline inspection

Check release-material availability and inspect the original offline bundle verifiers. TypeScript, Python and Elixir source downloads are candidate examples with checks pending. They do not provide a released bundle, executable collection, authenticated starter or permission to make requests.