身份验证

访问 Partner API 需要使用 API 密钥进行身份验证。请通过 Partner Console 生成和管理您的密钥。

API 密钥是您访问合作伙伴资源的凭据。每个密钥只能访问特定的组织数据,并可在需要时立即停用。

**请谨慎处理您的 API 密钥,它们可提供对您账户的完全访问权限!**切勿在公共代码库、客户端应用程序或任何可能导致泄露的地方暴露这些密钥。

使用 HTTP Basic Auth 对请求进行身份验证,将您的 API 密钥作为用户名传递,密码留空。

**API 仅接受安全的 HTTPS 连接。**纯 HTTP 请求将被拒绝,缺少正确身份验证凭据的请求也会被拒绝。

请求示例

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

验证密钥

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }