Skip to main content

Integrations

🚧 Coming Soon — This API is under active design. Endpoints return 501 Not Implemented until released.

Integrations connect the Transform Platform to external file sources and destinations. Register an integration once and reference it by ID in transformation jobs — the platform handles connectivity, authentication, and retry logic.

Supported Integration Types​

TypeDescription
SFTPSSH File Transfer Protocol
FTP / FTPSFTP with optional TLS
S3AWS S3 bucket
AZURE_BLOBAzure Blob Storage
GCSGoogle Cloud Storage
REST_APIGeneric HTTP endpoint
DATABASEJDBC-compatible database (read/write)
LOCAL_FSLocal or network-mounted filesystem

Planned Workflow​

  1. Store a credential: POST /api/v1/credentials → get a credentialId
  2. Register an integration: POST /api/v1/integrations referencing the credentialId
  3. Test connectivity: POST /api/v1/integrations/{id}/test
  4. Use in transformation jobs by referencing the integrationId as the source

Operations​

📄️ List integrations

🚧 *Coming Soon* — Returns all registered external integrations.

📄️ Register an integration

🚧 *Coming Soon* — Register a new external system integration.

📄️ Get integration by ID

🚧 *Coming Soon* — Retrieve an integration by its ID.

📄️ Update an integration

🚧 *Coming Soon* — Update integration configuration.

📄️ Delete an integration

🚧 *Coming Soon* — Remove an integration.

📄️ Test integration connectivity

🚧 *Coming Soon* — Verify the integration can connect to the external system.

Schema References​