Skip to main content

​
Integrations API guide

This page describes the connection lifecycle pattern. Detailed endpoint contracts are in the OpenAPI explorer.

​
Integration sequence

1

List current integrations

Call GET /api/integrations during settings/account bootstrap.
2

Start connect flow

Call POST /api/integrations/saltedge/connect and redirect users to provider UI.
3

Finish callback handling

Use GET /api/integrations/saltedge/finish after provider redirect completes.
4

Allow disconnect

Use DELETE /api/integrations/{integration_id} with explicit user confirmation.

​
Operational recommendations

  • Re-fetch integration list after connect/disconnect actions.
  • Log provider callback failures with request id for support workflows.
  • Keep provider-specific UI copy outside API contract assumptions.

​
Endpoint index

  • GET /api/integrations
  • POST /api/integrations/saltedge/connect
  • GET /api/integrations/saltedge/finish
  • DELETE /api/integrations/{integration_id}

​
Error handling baseline

  • 400: invalid path/query values
  • 401: access token missing/expired
  • 404: integration not found in scope
  • 429: apply throttling and retry backoff
  • 500: retry and escalate with request_id