Skip to navigation

Test a provider connection

View as MarkdownOpen in Claude

Verifies that the saved credentials are valid by executing the provider’s test_connection adapter script. The script makes a lightweight API call to the POS system.

On success, the connection status is automatically updated to connected. On failure, status is updated to error with the error message.

If no adapter script is available for this provider, falls back to basic credential validation.

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

slugstringRequired

Provider slug (e.g. “revel”)

Response

OK
codeinteger
isSuccessboolean
messagestring
latencyMsinteger

Errors

404
Not Found Error