Stub — This document is a placeholder. Full content will be added as the connector plugin API stabilises.
Overview
A connector plugin is a dynamically loaded module that implements the DPUse connector interface. It functions as a driver for a specific vendor product — handling authentication, protocol communication, data retrieval, and any product-specific operations.
When DPUse needs to access data from a vendor product, it loads the relevant connector plugin and supplies it with connection parameters (credentials and account configuration). The plugin uses those parameters to open a live communication channel and execute the requested operations.
Topics to be documented
- Connector plugin interface / contract
- Required methods and lifecycle hooks
- Authentication implementation (OAuth, API key, etc.)
- Exposing data items and schema
- Implementing data retrieval operations
- Error handling and connection state
- Packaging and registration
- Testing a connector plugin locally
- Publishing a custom connector plugin