Skip to main content

Connector Framework

The Nuntiq Connector Framework is the runtime you write Python integrations against. A connector pulls data into Nuntiq (suppliers, purchase orders, master data, lifecycle events from external systems) or pushes data out of it (invoices into an ERP, payment status into a finance suite, exports for a downstream warehouse).

Every connector you write follows the same shape:

def run(context):
    # context.api:      the Nuntiq API, already authenticated for this run
    # context.secrets:  credentials for the external system
    # context.config:   non-secret settings (URLs, customer codes, flags)
    # context.logger:   structured logging
    ...
    return {'pushed': 42}

You paste that file into a connector in the Nuntiq admin portal under one of the entrypoint keys (get_supplier, push_invoice, get_custom_1, ...), and a scheduler task or the invoice workflow runs it.

What's in this section​

Getting started →

Download the toolkit, run your first connector locally in five minutes.

Concepts →

How the framework, your script, and the Nuntiq API fit together. Job lifecycle, delta state, logging.

Integration patterns →

Cookbook: paginated REST pulls, SFTP file exchange, OAuth flows. Real working examples.

Reference →

Every SDK object you'll touch: JobContext, BaseLoad, each entity Load, the delta-state helper.

The toolkit​

The Connector Toolkit is a local sandbox that mirrors the production runtime exactly. Every framework call works against in-memory dummy data backed by JSON files, no accounts, no network, no AWS. You write your connector against the toolkit, watch it work, then ship the same .py file to production.

Download the toolkit →

Where to next​