API Reference

Test a connection using supplied credentials, without requiring an existing account.

post
https://platform.routy.app/api/v1/integrations/accounts/test-connection

The affiliate program id determines the base URL and integration type from the program's crawling settings;
the request's credentials (username/password, API key, or client id/secret) are then used to attempt a login.
Use this to validate credentials before creating an account. AffiliateProgramId is required.

🔐 Required permission: AccountAdmin

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The candidate credentials plus the AffiliateProgramId they should connect to.

Request model for testing account connection with provided credentials.
Used when testing credentials before creating an account or when testing
credentials independently of an existing account.

int32

The affiliate program ID to test the connection against.
Used to determine the base URL and crawler type from crawling settings.

string | null

Username credential for authentication.

string | null

Password credential for authentication.

string | null

API key credential for authentication.

string | null

Client identifier credential for OAuth-style authentication.

string | null

Client secret credential for OAuth-style authentication.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago