Xác thực và định dạng yêu cầu API phía máy chủ

Xác thực

Các yêu cầu API phải được xác thực bằng secret key hoặc public API key của bạn thông qua header Authorization. Bạn có thể tìm thấy chúng trong App Settings. Định dạng giá trị là Api-Key {your-secret-api-key}, ví dụ: Api-Key secret_live_....

API key là theo từng ứng dụng. Nếu bạn có nhiều ứng dụng, hãy đảm bảo sử dụng các key khác nhau cho mỗi ứng dụng.

Định dạng yêu cầu

Headers

Các yêu cầu API phía máy chủ yêu cầu các header cụ thể và phần thân JSON. Sử dụng thông tin bên dưới để cấu trúc yêu cầu của bạn.

Header	Mô tả
adapty-profile-id	ID hồ sơ người dùng Adapty của người dùng. Hiển thị trong trường Adapty ID trên trang Adapty Dashboard -> Profiles -> trang hồ sơ cụ thể. Có thể dùng thay thế cho adapty-customer-user-id, dùng một trong hai đều được.
adapty-customer-user-id	ID người dùng trong hệ thống của bạn. Hiển thị trong trường Customer user ID trên trang Adapty Dashboard -> Profiles -> trang hồ sơ cụ thể. Có thể dùng thay thế cho adapty-profile-id, dùng một trong hai đều được. ⚠️ Chỉ hoạt động nếu bạn xác định người dùng trong ứng dụng iOS, Android, React Native, Flutter, và Unity trong mã ứng dụng bằng Adapty SDK.
adapty-platform	(tùy chọn) Chỉ định nền tảng của thiết bị mà ứng dụng được cài đặt. Chúng tôi khuyến nghị đặt tham số này trong các yêu cầu Create profile và Update profile khi chỉnh sửa đối tượng Installation Meta, vì nó phụ thuộc vào thiết bị người dùng đang dùng và một người dùng có thể có nhiều thiết bị. Các giá trị có thể có: `iOS`, `macOS`, `iPadOS`, `visionOS`, `Android`, hoặc `web`.
Content-Type	Đặt thành `application/json` để API xử lý yêu cầu.

Body

API yêu cầu phần thân có định dạng JSON với dữ liệu cần thiết cho yêu cầu.

Giới hạn tốc độ

Để tránh bị throttle, hãy đảm bảo số lượng yêu cầu (mỗi ứng dụng) không vượt quá 40.000 yêu cầu mỗi phút.

Nếu vượt quá giới hạn này, hệ thống có thể bị chậm hoặc tạm thời chặn các yêu cầu tiếp theo nhằm duy trì hiệu suất tối ưu cho tất cả người dùng.

Xoay vòng API key

Nếu bạn cần xoay vòng secret API key:

Trong Settings → General, nhấp vào Generate new key, sau đó nhấp vào biểu tượng thùng rác bên cạnh key cũ.
Cập nhật key đang dùng trong ứng dụng của bạn.

Tiếp theo — các yêu cầu: