Function NewApiKeyHeaderAuthHTTPClient

common/apiKey.go:12–21

NewApiKeyHeaderAuthHTTPClient returns a new http client, with automatic API key authentication. Specifically this means that the client will automatically add the API key (as a header) to every request. HeaderValue must be in the correct format. This sometimes means adding prefix to the API Key.

( //nolint:ireturn
	ctx context.Context,
	headerName, headerValue string,
	opts ...HeaderAuthClientOption,
)

// add the API key (as a header) to every request.
// HeaderValue must be in the correct format. This sometimes means adding prefix to the API Key.
func NewApiKeyHeaderAuthHTTPClient( //nolint:ireturn
	ctx context.Context,
	headerName, headerValue string,
	opts ...HeaderAuthClientOption,
) (AuthenticatedHTTPClient, error) {
	return NewHeaderAuthHTTPClient(ctx, append(opts, WithHeaders(Header{
		Key:   headerName,
		Value: headerValue,
	}))...)
}

// NewApiKeyQueryParamAuthHTTPClient returns a new http client, with automatic API key
// authentication. Specifically this means that the client will automatically