Skip to main content

Downloads

Nuntiq Connector Toolkit​

The toolkit is a self-contained Python sandbox for writing and testing connectors on your own machine. Everything runs against in-memory dummy data backed by JSON files, so there is no Nuntiq account, no network and no AWS involved. Your connector talks to your real external system while Nuntiq is simulated.

nuntiq-connector-toolkit-0.4.5.zip

v0.4.5 · ~143 KB · Python 3.10+

Download zip

SHA-256: 45d88c8556a278523c7a20e8d2d6f8a682bdf2f41f29f6e7ee18a99c85c32051

Verify after download:

(Get-FileHash nuntiq-connector-toolkit-0.4.5.zip -Algorithm SHA256).Hash.ToLower()

What's inside​

nuntiq-connector-toolkit-0.4.5/
├── nuntiq.py                <- entrypoint you run
├── AGENTS.md                <- the whole picture for AI coding tools (and humans)
├── README.md
├── requirements.txt
├── settings/                <- one .json per connector instance (example.json is the template)
├── connectors/              <- 6 example entrypoints + your code: one file per entrypoint, shared_<name>.py = shared module
├── fixtures/                <- dummy data tables (JSON, edit freely)
├── docs/                    <- SDK reference (also on this site)
├── lib/                     <- the SDK you import
└── _toolkit/                <- sandbox internals (you can ignore)

See Toolkit overview for what each folder does, and Guide for coding assistants for the text of AGENTS.md: the production runtime contract, where every context value comes from, the entrypoint keys, and how a connector is set up in the admin portal.

Quick start​

  1. Unzip somewhere convenient.
  2. python -m venv .venv && .\.venv\Scripts\activate (Windows) or source .venv/bin/activate (macOS/Linux).
  3. pip install -r requirements.txt.
  4. cp settings/example.json settings/my_instance.json and edit it.
  5. python nuntiq.py.

Full walkthrough: Installation → Your first connector.

Changelog​

0.4.5 — 2026-09-13​

  • Global connectors are templates. Creating a customer connector copies the template's default config, entrypoints, shared modules and code as customer version 1; the copy is edited on the customer from then on. AGENTS.md and README section 7 describe the new setup flow (template, then customer connector from it, or a blank connector).

0.4.4 — 2026-09-13​

  • Shared code modules: a connectors/shared_<name>.py file without run() is a module every entrypoint of the connector can import by file name (from shared_zoho import ZohoBooks). In the admin portal it is pasted on the connector's new "Shared code" tab; the platform writes it next to the entrypoint at run time. The menu lists only files that define run() and names the shared modules.
  • AGENTS.md and README: the one-file rule replaced by the shared module rule; admin portal setup includes the Shared code tab.

0.4.3 — 2026-09-12​

  • SDK and docs: organization units use UUID ids and code is optional when a unit carries a source identity; organization types documented (1 Group, 2 Company, 3 Department); save() sends the whole object.
  • Fake API: organizations and suppliers match soft-deleted rows by source identity and revive them on save, as production does.

0.4.2 — 2026-09-12​

  • AGENTS.md added: one document that gives an AI coding tool or a new developer the full picture (runtime contract, context sources, entrypoint keys, admin portal setup, implementation checklist).

0.4.1 — 2026-09-12​

  • External identity documented: source_system, source_record_id, source_updated_at on suppliers, supplier locations and organization units; 02_pull_suppliers.py stamps them.
  • docs/organization.md: the read, merge, save pattern for records that people also edit by hand; code optional for units with a source identity.

0.4.0 — 2026-09-12​

  • SDK: external identity fields on Supplier, SupplierLocation, Organization; BaseLoad.index_by_source().
  • Fake API matches on (source_system, source_record_id) before the natural key, as production does.

0.3.0 — 2026-09-12​

  • SDK resynced with the production framework: purchase order, PO line and receipt field names (net_amount, tax_amount, gross_amount, description), discount basis fields on invoices, and three objects that were missing (IngestionLoad, LifecycleMessageLoad, UserLoad).
  • lib/api_client.py ships ApiError, and the sandbox raises it, so except ApiError behaves the same locally and in production.
  • Fixtures use the production invoice field keys (invoiceNumber, grossAmount, matched_supplier_number, ...); a user.json fixture.
  • Fake API: /v1/users, /v1/invoice-import, real source-document result shape.
  • README: settings/ layout and the rules that only bite in production.
  • New docs: ingestion.md, lifecycle_message.md, user.md.

0.2.0 — 2026-05-16​

  • Renamed from ap-receiving-connector-sandbox → nuntiq-connector-toolkit to match the platform rebrand.
  • Bundled with the Nuntiq developer portal.

0.1.0 — 2026-04-25​

  • Initial release. Six example connectors covering the four most common shapes (pull with delta, push with claim/ack/result, lifecycle poll, read-only export).

Stay current​

Toolkit releases are versioned alongside the production framework. Major behavioural changes get a major-version bump; SDK additions are minor. Anything you've written against an older toolkit should run unchanged on the next minor version. Connectors written against 0.2.0 need one check before running on 0.3.0 or later: invoice field keys are the capture template's camelCase names, not snake_case.

The framework itself ships on a separate cadence maintained by Nuntiq. Both share the SDK in lib/ byte-for-byte, so anything that imports cleanly in your toolkit will import cleanly in production at the version you tested against.