Авторизация и формат запросов Server-side API

Авторизация

Запросы к API должны быть аутентифицированы с помощью секретного или публичного ключа API, передаваемого в заголовке Authorization. Найти их можно в разделе App Settings. Формат значения: Api-Key {your-secret-api-key}, например Api-Key secret_live_....

Ключи API привязаны к конкретному приложению. Если у вас несколько приложений, убедитесь, что для каждого используется отдельный ключ.

Формат запроса

Заголовки

Запросы к серверному API требуют определённых заголовков и тела в формате JSON. Используйте приведённые ниже сведения для формирования запросов.

ЗаголовокОписание
adapty-profile-id

Adapty profile ID пользователя. Отображается в поле Adapty ID на странице Adapty Dashboard -> Profiles -> конкретный профиль.

Взаимозаменяем с adapty-customer-user-id — используйте любой из них.

adapty-customer-user-id

ID пользователя в вашей системе. Отображается в поле Customer user ID на странице Adapty Dashboard -> Profiles -> конкретный профиль.

Взаимозаменяем с adapty-profile-id — используйте любой из них.

⚠️ Работает только если вы идентифицируете пользователей в приложении в коде приложения с помощью Adapty SDK.

adapty-platform(необязательно) Укажите платформу устройства, на котором установлено приложение. Рекомендуем задавать этот параметр в запросах Create profile и Update profile при изменении объекта Installation Meta, поскольку он зависит от устройства пользователя, а у одного пользователя может быть несколько устройств. Допустимые значения: iOS, macOS, iPadOS, visionOS, Android или web.
Content-TypeУкажите application/json, чтобы API обрабатывал запрос.
Body

API ожидает тело запроса в формате JSON с необходимыми данными.

Ограничения по частоте запросов

Чтобы избежать ограничений по частоте, следите за тем, чтобы количество запросов (на одно приложение) не превышало 40 000 в минуту.

При превышении этого лимита система может замедлиться или временно заблокировать дальнейшие запросы — это нужно для поддержания оптимальной производительности для всех пользователей.

Ротация API-ключей

Если нужно сменить секретные API-ключи:

  1. В разделе Settings → General нажмите Generate new key, затем нажмите на иконку корзины рядом со старым ключом.
  2. Обновите ключ в своём приложении.

Что дальше: запросы: