Developer reference
Build an integration
Start with a read-only user credential and add operations according to the user’s intent.
Begin with one read-only request whose result you can recognize. Add write behavior only when it solves a concrete task and preserves the financial command contract.
Recommended sequence
- Follow the read-only quickstart.
- Confirm the returned account names, currencies and ownership.
- Choose an integration pattern.
- Implement error handling and bounded reads.
- Read financial safety before adding mutations.
Use the intended boundary
The HTTP API handles authentication, scopes, input validation and domain constraints. A third-party tool should not hold a service-role key or edit financial tables directly.
Use a separate named API token for the integration, stored server-side. Keep permission minimal and revoke it when the integration ends.
Preserve the financial story
An account amount needs currency and evidence. A due obligation is a plan, not proof of payment. A transfer is not income, and an original foreign purchase is not necessarily the amount settled in the account.
Your integration should preserve these distinctions rather than simplifying an incomplete answer into a misleading total.
Current interface options
HTTP is the implemented transport. Generated machine descriptions help inventory registered operations, but a separately hosted MCP transport is planned.