导语
该系列其他篇章:
V3手动鉴权失败之Nodejs篇
V3手动鉴权失败之Go篇
V3手动鉴权失败之Java篇
V3手动鉴权失败之PHP篇
V3手动鉴权失败之C#篇
腾讯云 API 全新升级 3.0 ,该版本进行了性能优化且全地域部署、支持就近和按地域接入、访问时延下降显著,接口描述更加详细、错误码描述更加全面、SDK增加接口级注释,让您更加方便快捷的使用腾讯云产品。人脸识别、文字识别,语音识别等众多产品均已接入云API 3.0。
腾讯云API为了更好的让用户接入,已经封装好了多种语言的SDK,只需用户传入SecrectId、SectectKey以及接口入参,即可完成接口鉴权和请求发送,具体包括Python SDK、Java SDK、PHP SDK、Go SDK、NodeJS SDK、.NET SDK。
案例背景
在某些情况,用户需要实现手动接口鉴权,虽然官网文档已有详细的接口鉴权流程,但是由于:
1.V3手动鉴权步骤较为复杂;
2.官网某些demo代码无法直接下载运行,仍需简单调整;
3.官网文档的demo代码覆盖面有限,没有包括全量上述六类后端语言;
基于此,很多用户只能自己尝试手动鉴权,但都返回“鉴权失败”,从而无法调通接口。
原因分析
从宏观上看,“鉴权失败”要关注两个阶段:
1. 整体的接口鉴权是否正确;
2. 模拟的鉴权请求的发送是否正确;
从历史问题回顾,有客户曾经出现接口鉴权时而成功,时而失败的情况,排查了整体的鉴权过程,完全正确,但是也的确复现了客户的问题。后来发现,用户在鉴权完成后,发送具体的请求时,传入的时间戳timestamp没有实时更新导致了报错。
解决方案
为了帮助客户更简单、更快捷地完成接口手动鉴权,并成功发送鉴权请求,将通过一系列文章专门讲解各个后端语言的手动鉴权&发送请求的可执行demo代码,助力客户快速接入。
本期将以调用人脸识别的DetectFace接口为例,详叙Python语言
demo。
前期准备
Python语言环境:直接在Python官网根据操作系统类型下载并安装指定安装包即可。
SecrectId和SecretKey:接口鉴权的密钥。可以把SecretId理解成“账号”,把SecretKey理解成“密码”。在自己的腾讯云官网控制台获取:访问管理 -> 访问密钥 -> API密钥管理。
手动鉴权相关文档:请求结构、公共参数、V3接口鉴权
具体代码
运行python语言代码,即可完成v3鉴权,并发送http请求,收到具体的response响应。运行指令为:
代码语言:javascript复制python python_v3.py
具体的python_v3.py代码如下,只需要简单复制,然后输入自己的SecretId和SecretKey两个字段即可:
代码语言:javascript复制# -*- coding: utf-8 -*-
import hashlib, hmac, json, os, sys, time
from datetime import datetime
import requests
# 密钥参数
secret_id = "xxx"# 传入自己的secretId
secret_key = "xxx"# 传入自己的secretKey
service = "iai"
host = "iai.tencentcloudapi.com"
endpoint = "https://" host
region = "ap-guangzhou"
action = "DetectFace"
version = "2018-03-01"
algorithm = "TC3-HMAC-SHA256"
timestamp = int(time.time())
#timestamp = 1551113065
date = datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%d")
params = {"Url": "https://img.yuanmabao.com/zijie/pic/2020/12/11/bszycpy3gtx.jpg"}
# ************* 步骤 1:拼接规范请求串 *************
http_request_method = "POST"
canonical_uri = "/"
canonical_querystring = ""
ct = "application/json; charset=utf-8"
payload = json.dumps(params)
canonical_headers = "content-type:%snhost:%sn" % (ct, host)
signed_headers = "content-type;host"
hashed_request_payload = hashlib.sha256(payload.encode("utf-8")).hexdigest()
canonical_request = (http_request_method "n"
canonical_uri "n"
canonical_querystring "n"
canonical_headers "n"
signed_headers "n"
hashed_request_payload)
print(canonical_request)
# ************* 步骤 2:拼接待签名字符串 *************
credential_scope = date "/" service "/" "tc3_request"
hashed_canonical_request = hashlib.sha256(canonical_request.encode("utf-8")).hexdigest()
string_to_sign = (algorithm "n"
str(timestamp) "n"
credential_scope "n"
hashed_canonical_request)
print(string_to_sign)
# ************* 步骤 3:计算签名 *************
# 计算签名摘要函数
def sign(key, msg):
return hmac.new(key, msg.encode("utf-8"), hashlib.sha256).digest()
secret_date = sign(("TC3" secret_key).encode("utf-8"), date)
secret_service = sign(secret_date, service)
secret_signing = sign(secret_service, "tc3_request")
signature = hmac.new(secret_signing, string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
print(signature)
# ************* 步骤 4:拼接 Authorization *************
authorization = (algorithm " "
"Credential=" secret_id "/" credential_scope ", "
"SignedHeaders=" signed_headers ", "
"Signature=" signature)
print(authorization)
print("curl请求指令如下:")
print('curl -X POST ' endpoint
' -H "Authorization: ' authorization '"'
' -H "Content-Type: application/json; charset=utf-8"'
' -H "Host: ' host '"'
' -H "X-TC-Action: ' action '"'
' -H "X-TC-Timestamp: ' str(timestamp) '"'
' -H "X-TC-Version: ' version '"'
' -H "X-TC-Region: ' region '"'
" -d '" payload "'")
# 发送http请求
header = {"Authorization":authorization,
"Content-Type":"application/json; charset=utf-8",
"Host":host,
"X-TC-Action":action,
"X-TC-Timestamp":str(timestamp),
"X-TC-Version":version,
"X-TC-Region":region}
# 方法一:传入dict作为json的值
# response = requests.post(url=endpoint, headers=header, json=params)
# 方法二:传入json对象作为data的值,其中payload=json.dumps(params)
response = requests.post(url=endpoint, headers=header, data=payload)
print(response.json())