Skip to main content
When the gallery lacks a vendor or you need proprietary internal APIs, you build a custom connector with the Connector Development Kit (CDK). You ship Python modules that declare metadata, authentication, discovery, and read/write operations Planasonix orchestrates like first-party connectors.

​
CDK overview

The CDK provides:
  • Spec contracts – define capabilities (batch extract, load, streaming) and configuration schema
  • Runtime hooks – implement list, read, write, and test methods
  • Packaging – bundle dependencies within supported constraints
  • Local testing – run against sample payloads before publishing to your workspace
Custom connectors inherit your organization’s security review: secrets never belong in source code; use connection parameters and vault references.

​
Python CDK

Author connectors in Python when you need rapid iteration and rich HTTP/SDK libraries:
1

Scaffold the project

Use the CDK template to generate package layout, connector.yaml, and sample tests.
2

Implement auth

Support API keys, OAuth refresh, or mTLS as required by your target system.
3

Discovery

Return object and field metadata dynamically or from static definitions when APIs are thin.
4

Read/write paths

Implement pagination, backoff, and checkpointing for incremental extracts; respect destination batch limits on load.
5

Validate locally

Run unit tests with recorded HTTP fixtures; exercise error paths (401, 429, 500).

​
Validation

Before publishing, run validation suites that check:
  • Schema of configuration JSON matches the declared form
  • Required methods exist for advertised capabilities
  • Dependency versions stay within allowlisted ranges
Fix validation errors locally—CI should block merges that fail validation.

​
Publishing

Publish connectors to your private registry or workspace library depending on deployment. Tag versions semantically (1.4.2); pipelines pin connector versions so upgrades are explicit.
Install the connector in a staging workspace first; run synthetic and mirrored production workloads.
Connectors execute with network access to your sources—apply egress controls and code review for outbound URLs.

Connector gallery

Compare first-party coverage before building custom.

API keys

Secure programmatic testing of connectors.