Test a connection
The Test Connection button appears at the top of the editor for API Auth Profiles, Data Sources, Rest Data Sources and API Requests. On a data source or API request, it tests the API Auth Profile that item has picked.
Before you start
Save the API Auth Profile first. The test uses the profile's saved settings.
Steps
-
Open the item
In the back office, open the API Auth Profile, or a data source or API request that uses it.
-
Select Test Connection
Select Test Connection at the top of the editor.
-
Read the result
A notification headed Test Connection appears. Green means success and red means there's a problem. Use the tables below to understand the message.
More detail
What the test checks
ApiKeyandStaticTokenprofiles: checks that Three 17 has stored a token under the Credential Key. It doesn't call the other system.ClientCredentialsprofiles: requests a fresh access token from the Token Endpoint.
To check that the other system accepts the credentials and returns data, create a dataset and use its Preview tab. For an OData data source, the Entity Set list loading in a new dataset is also a good sign.
Success messages
| Message | Meaning |
|---|---|
| Credential '...' is configured. | A token is stored under this Credential Key. |
| Token endpoint responded successfully. | The client ID and secret were accepted and a token was issued. |
Problem messages
| Message | What to do |
|---|---|
| No API Auth Profile selected. | Pick an API Auth Profile on the data source or API request. |
| No credential configured for key '...'. | No secret is stored under that Credential Key yet. Check the key is spelled exactly as you gave it to Three 17, or ask Three 17 support to add it. |
| API credential '...' must define ClientId and ClientSecret. | The stored credential is missing a client ID or secret. Ask Three 17 support to check it. |
| API auth profile token endpoint is required for client credentials auth. | Fill in Token Endpoint, then save. |
| Token request failed with status ... | The token endpoint turned the request down. Check the Token Endpoint and Scope, and that the client ID and secret are current. A status of 400 or 401 usually means the secret, client ID or scope is wrong. |
| API auth profile '...' must define auth mode. | Choose an Auth Mode and save. |
| Request failed with status 429. | You've reached the limit of 60 requests a minute. Wait a minute and try again. |
| A message about refusing to connect to a private, loopback or link-local address | The token endpoint points at an internal address, which AutomatedOn blocks. Use the public address. |