How to Configure Client

Client is the TypeScript client used to obtain resources such as upgrade strategies. To initiate requests using the TypeScript SDK, you need to initialize a Client instance and modify the default configuration items of the Client as needed.

Prerequisites

• Registered upgradeLink account.
• Obtained AccessKey and AccessSecret.

Obtain Credentials

Default Configuration Example

const {
    default: Client,
    Config,
} = require('@toolsetlink/upgradelink-api-typescript');

// Test client initialization
async function testClientInit() {
    try {
         // Initialize client
        const config = new Config({
            accessKey:  'mui2W50H1j-OC4xD6PgQag',
            accessSecret: 'PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc',
        });
        const client = new Client(config);
        
    } catch (error) {
        console.error('\n err:', error);
    }
}

Configuration Parameter Summary

Parameter	Required	Type	Example Value	Description
accessKey	Yes	string	89c8b3d5f2a74e1b
secretKey	Yes	string	89c8b3d5f2a74e1b
protocol	No	string	HTTPS	Protocol, default is HTTP
endpoint	No	string	api.api.com	Service domain name, default is api.upgrade.toolsetlink.com, can be switched to your own service domain name.