服务器端 API 授权与请求格式

授权

API 请求必须通过 Authorization 请求头进行身份验证，可使用您的私密或公开 API 密钥。您可以在 App Settings 中找到这些密钥。值的格式为 Api-Key {your-secret-api-key}，例如 Api-Key secret_live_...。

API 密钥与应用绑定。如果您有多个应用，请确保为每个应用使用不同的密钥。

请求格式

请求头

服务端 API 请求需要特定的请求头和 JSON 请求体。请参考以下信息构建你的请求。

HeaderDescription
adapty-profile-id

用户的 Adapty 用户画像 ID。可在 Adapty 看板 -> Profiles -> 具体用户画像页面的 Adapty ID 字段中查看。

与 adapty-customer-user-id 可互换使用，任选其一即可。

adapty-customer-user-id

用户在您系统中的 ID。可在 Adapty 看板 -> Profiles -> 具体用户画像页面的 Customer user ID 字段中查看。

与 adapty-profile-id 可互换使用，任选其一即可。

⚠️ 仅当您在应用代码中通过 Adapty SDK 在应用中识别用户 识别用户时才有效。

adapty-platform（可选）指定安装应用的设备平台。建议在 Create profile 和 Update profile 请求中修改 Installation Meta 对象时设置此参数，因为该参数取决于用户所使用的设备，而同一用户可能拥有多台设备。可选值：iOS、macOS、iPadOS、visionOS、Android 或 web。
Content-Type设置为 application/json，以便 API 正确处理请求。
请求体

API 需要一个 JSON 格式的请求体，其中包含请求所需的数据。

请求频率限制

为避免请求被限速，请确保每个应用的请求数量保持在每分钟 40,000 次以下。

如果超出此限制，系统可能会降速或暂时拦截后续请求，以确保所有用户都能获得最佳体验。

轮换 API 密钥

如需轮换私密 API 密钥：

  1. 在 Settings → General 中，点击 Generate new key，然后点击旧密钥旁边的垃圾桶图标。
  2. 更新应用中使用的密钥。

下一步：请求：