SetAPIKey VI

Owning Palette: Security VIs

Requires: Base Development System

Provides API Key authentication credentials for Web requests associated with the client handle. API key security is one available option to protect LabVIEW Web services. Client handles save the credentials across multiple Web requests. Use the Open Handle VI to open a client handle.

Add to the block diagram

Find on the palette

	mode specifies the API key mode. The default value is NIWS.
	client handle specifies the client handle to associate with the Web request. Use client handles to wire together multiple HTTP Client VIs while preserving authentication credentials, HTTP headers, and cookies. Client handles are not required when making independent Web requests without persistent data such as headers or credentials.
	access id specifies the public component of the API key when accessing a LabVIEW Web service. The access id must match the Access ID when you setup API key security on the Application Web Server.
	secret id specifies the private component of the API key when accessing a LabVIEW Web service. The secret id must match the Secret ID when you setup API key security on the Application Web Server.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	client handle out returns the client handle associated with the Web request. Use client handles to wire together multiple HTTP Client VIs while preserving authentication credentials, HTTP headers, and cookies. Client handles are not required when making independent Web requests without persistent data such as headers or credentials.
	error out contains error information. This output provides standard error out functionality.