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

授权

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

请求格式

请求头

服务器端 API 请求需要特定的请求头和 JSON 正文。请使用以下详细信息来构建您的请求。

请求头说明
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(可选)指定安装应用的设备平台。我们建议在修改 Installation Meta 对象时,在 Create profileUpdate profile 请求中设置此参数,因为该对象取决于用户所使用的设备,而单个用户可能拥有多台设备。可选值:iOSmacOSiPadOSvisionOSAndroidweb
Content-Type设置为 application/json,以便 API 处理请求。

正文

API 期望接收包含请求所需数据的 JSON 格式正文。

速率限制

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

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


下一步:请求操作: