本文档旨在帮助开发者解决在使用 Tapkey REST API 获取 Owner 列表时遇到的 401 Unauthorized 错误。该错误通常是由于 Authorization Header 设置不正确导致的。本文将提供详细的解决方案，包括正确的 Header 设置方式，并提供示例代码，确保开发者能够顺利访问 Tapkey API。
问题分析
当尝试使用 Tapkey REST API 获取 Owner 列表时，即使拥有正确的 OAuth 凭据和启用的 scopes，仍然可能遇到 401 Unauthorized 错误。 这通常表示 API 无法验证您的身份。
解决方案
最常见的原因是 Authorization Header 的格式不正确。 Tapkey API 期望 Authorization Header 的格式为 Bearer {token}，其中 {token} 是您的访问令牌。
以下是使用 Python requests 库的示例代码，展示了如何正确设置 Authorization Header：
import requests
tapkey_api_url = "https://my.tapkey.com"
tapkey_api_version = "/api/v1"
tapkey_auth_server = "https://login.tapkey.com"
tapkey_client_id = "xxx" #redacted
tapkey_client_secret = "yyy" #redacted
def get_access_token(url, client_id, client_secret):
response = requests.post(
url,
data={"grant_type": "client_credentials", "scope": "read:owneraccounts read:owneraccount:permissions"},
auth=(client_id, client_secret),
)
token_json = response.json()
return token_json["access_token"]
token = get_access_token(f"{tapkey_auth_server}/connect/token", tapkey_client_id, tapkey_client_secret)
print(f"Received token: {token}")
owners_url = f"{tapkey_api_url}{tapkey_api_version}/Owners"
print(owners_url)
# Corrected Authorization Header
response = requests.get(owners_url, headers={"Authorization": f"Bearer {token}"})
print(response)关键在于这一行：
response = requests.get(owners_url, headers={"Authorization": f"Bearer {token}"})请注意，Authorization 键的值必须以 Bearer（注意空格）开头，后跟您的访问令牌。
验证步骤
- 确认 Scope: 确保您请求的访问令牌包含必要的 scopes (例如, read:owneraccounts 和 read:owneraccount:permissions)。
- OAuth 设置: 确认这些 scopes 已在 Tapkey 管理门户的 OAuth 设置中启用。
- 服务帐户权限: 确保服务帐户的电子邮件地址已作为管理员添加到您的 Tapkey 帐户。
- Header 格式: 仔细检查 Authorization Header 的格式是否正确，确保使用 Bearer {token} 格式。
注意事项
- 确保您的访问令牌没有过期。 如果令牌已过期，您需要重新获取一个新的令牌。
- 检查您的 API 调用 URL 是否正确。
- 如果您仍然遇到问题，请检查 Tapkey API 的文档，以获取有关身份验证和授权的更多信息。
总结
通过正确设置 Authorization Header，您可以避免 401 Unauthorized 错误，并成功访问 Tapkey API 获取 Owner 列表。 记住，正确的 Header 格式是 Bearer {token}。 遵循本文档中的步骤，您应该能够顺利地集成 Tapkey API 到您的应用程序中。
