tencent cloud

All product documents
API Gateway
DocumentationAPI GatewayDevelopment GuideSignature Tool
Signature Tool
Download PDF
Last updated: 2023-12-22 10:06:39
Signature Tool
Last updated: 2023-12-22 10:06:39
Download PDF

Overview

The API Gateway signature tool is a web tool provided by Tencent Cloud API Gateway to generate request signatures for key pair authentication APIs. You can set parameters on the signature tool page in the API Gateway console to generate a request signature.

Prerequisites

Postman has been downloaded and installed (download address).

Directions

Step 1. Enter the basic information for a signature

1. Log in to the API Gateway console.
2. In the left sidebar, click Tool > Signature Tool to go to the signature tool page.
3. In the Basic info module, click Obtain. The system will automatically fill in the start time and end time of the signature validity period.
4. Enter any value as the signature watermark value.




Step 2. Enter an API key pair

In the Secret key module, set the API key pair information using either of the following methods:
Method 1: click Select to select a key pair that has been created under your account.
Method 2: enter a key pair.
Make sure you enter the correct information. If the information is incorrect, your signature will be invalid.




Step 3. Generate a signature

Click Generate signature. The request signature result will be displayed in the module on the right. The main parameters are as follows:
Source: signature watermark value.
X-Date: HTTP request construction time in GMT format. The difference between X-Date and the current time cannot exceed 15 minutes.
Authorization: signing information.




Step 4. Initiate a call in Postman

Open Postman, enter the Source, X-Date, and Authorization parameters in Headers, enter the API request address, API request parameters, and other information, and click Send to call the key pair authentication API.



Note

Because the server will verify the time, you must initiate a call within the validity period of the signature. Otherwise, the call will fail.
The signature tool only verifies the validity of the parameters, but does not identify or inform you of the specific incorrect parameters.
For more information about key pair authentication, see Key Pair Authentication.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon