The full interactive API documentation is available on our Swagger UI:
Authentication
To use the API, you need to obtain an access token first. See the Authentication page for details on how to get your credentials and request a token.
Vendor communication errors
Requests that contact a device vendor can return 502 with errorCode and type set to
vendorCommunicationError. This includes connection failures where no HTTP response is received
from the vendor. Treat this as a communication failure and retry later with increasing delays;
it does not by itself mean the user's vendor credentials are invalid.
A cancelled or failed vendor login is not a communication failure. If the OAuth redirect URL
forwarded to POST /vendors/{vendorId}/connections carries an error parameter, the request fails
with 400 and errorCode vendorAuthorizationDenied or vendorAuthorizationFailed; previously, such
URLs returned 502. Retrying the same redirect URL cannot succeed; start a new vendor authorization
instead. See Vendor authorization errors.
Use errorCode to choose the next action and retain traceId for support. The human-readable
detail is not a stable value to parse. See the onboarding response guide
for the distinction between API-token errors, vendor authentication failures, communication errors
and unexpected internal errors.
Interactive Developer Tool
For manual testing and support, a browser-based terminal UI for the Connect API is available:
It lets you walk through the whole onboarding flow interactively — browse the vendor catalog and its connection options, create connections, and inspect or remove the resulting devices — while showing the raw request and response of every call.
Credentials are required: There is no no public API access. You need the same OAuth2 client_id and client_secret that you use for the API itself (see Authentication), plus the userId you want to work with. The OAuth2 credentials are issued by Clever-PV — without them the tool cannot be used.