tencent cloud

All product documents
API Gateway
DocumentationAPI GatewayOperation GuideCalling APICalling Key Pair Authentication API
Calling Key Pair Authentication API
Download PDF
Last updated: 2023-12-22 09:49:43
Calling Key Pair Authentication API
Last updated: 2023-12-22 09:49:43
Download PDF

Overview

This document describes how to call the key pair authentication API.

Prerequisites

Creating key pair authentication API

1. In the API Gateway console, create an API and select the authentication type as "key pair authentication" (for more information, see API Creation Overview).
2. Release the service where the API resides to an environment. See Service Release and Deactivation.
3. Create a key pair on the key management page in the console.
4. Create a usage plan on the usage plan page in the console and bind it to the created key pair (for more information, see Sample Usage Plan).
5. Bind the usage plan to the API or the service where the API resides.

Confirming information

Before calling the API, you must have the SecretId and SecretKey of the API to be called and understand the API request path, method, and parameters.

Preparing tools

You can initiate requests from sources including browsers, browser plugins, Postman, and clients. Postman is recommended for simple validation.

Sample Call

Address


http://service-xxxxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com/release
// Enter the URL of the API service you want to call
URL concatenation rule: service path + environment parameter + API path

Methods

POST

Request body

QueryParam_a=value1&QueryParam_b=value2

Request headers

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Accept-Language: zh-cn
Connection: Keep-Alive
Host: service-xxxxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com/release
User-Agent: Mozila/4.0(compatible;MSIE5.01;Window NT5.0)
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded;charset=utf-8
// Request body type, which should be set according to the actual request body content.
X-Client-Proto: http
X-Client-Proto-Ver: HTTP/1.1
X-Real-IP: 163.xxx.xx.244
X-Forwarded-For: 106.xxx.xx.102, 163.xxx.xx.244
Date: Sun, 21 Sep 2017 06:18:21 GMT
Authorization: hmac id="AKIDCgXXXXXXXX48pN", algorithm="hmac-sha1", headers="Date Host", signature="630123456789da9c"
// Signature. For specific signature algorithms, see the key calculation method in authentication and security
The eventually delivered HTTP request contains at least two headers: Date or X-Date and Authorization. More optional headers can be added in the request. If Date is used, the server will not check the time; if X-Date is used, the server will check the time.
The value of Date header is the construction time of the HTTP request in GMT format, such as Fri, 09 Oct 2015 00:00:00 GMT.
The value of X-Date header is the construction time of the HTTP request in GMT format, such as Mon, 19 Mar 2018 12:08:40 GMT. It cannot deviate from the current time for more than 15 minutes.
For the value of Authorization header, see Key Pair Authentication. For sample signatures generated in different programming languages, see API Gateway.

Response Processing

Response code

Response Code
Description
200 ≤ code < 300
Success
300 ≤ code < 400
Redirect, which requires subsequent operations to complete the request
400 ≤ code < 500
Client error
code > 500
Server error

Response headers

Content-Type: text/html; charset=UTF-8
Content-Length: 122
Date: Sun, 21 Sep 2017 06:46:04 GMT
Server: squid/3.5.20
Connection: close
Set-Cookie:1P_JAR=2017-09-18-06; expires=Mon, 25-Sep-2017 06:46:04 GMT; path=/; domain=.qq.com
X-Secret-ID:AKIDXXXXXXXX48pN
// `secret_id` in key pair
X-UsagePlan-ID:XXXXXXXX
// ID of the usage plan bound to the key pair
X-RateLimit-Limit:500
// Throttling configuration in the usage plan
X-RateLimit-Used:100/125
// Throttling usage in the usage plan


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