Configuration APIIntegrations

Test whether the integration connection is successful

Requires the INTEGRATION.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

integration_typestringOptional
The type of integration to test the connection for
e_invoicing_processorstringOptional
The processor to connect with when testing an eInvoicing integration
tax_calculation_variantstringOptional
The variant to connect with when testing a tax calculation integration

Request

This endpoint expects an object.
api_keyobjectOptional
client_credentialsobjectOptional
username_passwordobjectOptional

Response

OK
successfulboolean or nullRead-only
messagestring or nullRead-only

Errors

401
Unauthorized Error
403
Forbidden Error