API Key Authentication

The API Key authentication method uses an additional header to be passed into the request. This method’s token is pre-determined and supplied by the credential.

To use API Key, you must select API Key Authentication from the “Authentication Type” drop-down list and specify a prefix and suffix for the token if you have information prior-to or after the token. The format for the token is <Prefix> <API Key> <Suffix>.

The fields available with API Key Authentication are:

  • Authorization Header: This field describes the name of the header to be sent. Default: Authorization. This field is optional.

  • Prefix: This field is used if a prefix is required before the token. This field is optional.

  • Suffix: This field is used if a suffix is required after the token. This field is optional.

  • API Key: This field specifies the API Key that is used to make the request. This field is required.

Example 1

You need to make a request to a web-server (data server) that requires a pre-defined API Key to be included in the header. The data server expects the header Authorization: CoolBeans to be specified with the request.

To configure this authentication, the following fields are required:

  • API Key: CoolBeans

Example 2

You need to make a request to a web-server (data server) that requires a pre-defined API Key to be included in the header. The data server expects the header MyAuth: Cool CBToken Beans to be specified with the request.

To configure this authentication, the following fields are required:

  • Authorization Header: MyAuth

  • Prefix: Cool

  • Suffix: Beans

  • API Key: CBToken