Connections
Every connection should have a way how to check if the used API Key/Token is valid (Validation Endpoint). That means each connection should have a part that uses the used API Key/Token against some endpoint that requires only the API Key/Token to run. For example, User Info endpoint or any endpoint which is used to List data.
The validation endpoint is located:
OAuth1 and OAuth2 - the
info
directiveAPI Key, Basic Auth, Digest Auth, Other - the
url
which is in the Communication tab
There are APIs, which don't have a validation endpoint. In this case, it is recommended to call an endpoint, which will work in every case, and if possible will return the account's data, e. g. an endpoint /about
or /me
, etc.
The API Key is checked against /whoami
endpoint which in case of wrong API Key returns an error and the connection won't be created.
Connection metadata
It is recommended to use the metadata
parameter to store the account's name or email. This allows users to easily distinguish their stored connections, especially if they don't name their connections in a good manner.
Notice the value in the brackets after the user's connection name. This value is taken from the metadata
parameter.
Error handling
Error handling can be used from the Base tab and follows the same rules.
The only difference is where to use it in what type of connection. For example, in connection types OAuth 1.0 and OAuth 2.0, the error handling should be in the "info" part.
pageError handlingLast updated