POST /api/v2/server-side-api/profile/

Создать профиль

Copy as Markdown

Создаёт нового конечного пользователя вашего приложения в Adapty.

Header parameters

adapty-customer-user-idstring

Уникальный ID клиента в вашей системе. Требуется либо adapty-customer-user-id, либо adapty-profile-id.

adapty-profile-idstring

Уникальный ID профиля в вашей системе. Лучший вариант при работе с анонимными профилями. Требуется либо adapty-customer-user-id, либо adapty-profile-id.

adapty-platformstring

Платформа устройства, на котором у пользователя установлено ваше приложение

Request body

first_namestring

Имя вашего конечного пользователя

last_namestring

Фамилия вашего конечного пользователя

genderstring

Пол вашего конечного пользователя

One of: "f", "m", "o"

emailstring

Email вашего конечного пользователя

phone_numberstring

Номер телефона вашего конечного пользователя

birthdaystring

Дата рождения вашего конечного пользователя

ip_countrystring

Страна конечного пользователя в формате ISO 3166-2

ip_v4_addressstring

IPv4-адрес конечного пользователя

store_countrystring

Страна стора конечного пользователя

storestring

Платформа, которую пользователь использует для совершения покупок в вашем приложении

One of: "app_store", "play_store", "stripe", "adapty", "paddle"

store_account_tokenstring

Токен аккаунта стора

att_statusinteger

Статус Apple App Tracking Transparency (0=не определён, 1=ограничен, 2=отклонён, 3=авторизован)

One of: 0, 1, 2, 3

analytics_disabledboolean

Параметр для отказа от внешней аналитики

custom_attributesarray of object

Позволяет задать до 30 пользовательских атрибутов для профиля

keystringrequired

Ключ должен быть строкой длиной не более 30 символов. Допускаются только буквы, цифры, дефисы, точки и подчёркивания

valuestring | numberrequired

Значение атрибута должно содержать не более 50 символов. В качестве значений допускаются только строки и числа с плавающей точкой

installation_metaobjectrequired
device_idstringrequired

Уникальный идентификатор устройства

devicestring

Информация об устройстве

localestring

Локаль устройства

osstring

Информация об операционной системе

platformstring

Платформа (iOS, Android и т.д.)

One of: "iOS", "macOS", "iPadOS", "Android", "visionOS", "web"

timezonestring

Часовой пояс устройства

user_agentstring

Строка user agent

app_buildstring

Версия сборки приложения

app_versionstring

Версия приложения

adapty_sdk_versionstring

Версия SDK Adapty

idfastring

iOS Identifier for Advertisers

idfvstring

iOS Identifier for Vendor

advertising_idstring

Android advertising ID

android_idstring

Android device ID

android_app_set_idstring

Android app set ID

Responses

Профиль успешно создан

Schema
dataobjectrequired
app_idstringrequired

Внутренний ID вашего приложения

profile_idstringrequired

ID профиля в Adapty

customer_user_idstringrequired

ID вашего пользователя в вашей системе

total_revenue_usdnumberrequired

Число с плавающей точкой, представляющее суммарный доход в USD, полученный в рамках профиля

segment_hashstringrequired

Внутренний параметр

timestampintegerrequired

Время ответа в миллисекундах, используется для разрешения гонки состояний

custom_attributesarray of objectrequired

Для профиля допускается задать не более 30 пользовательских атрибутов

keystringrequired

Ключ должен быть строкой длиной не более 30 символов. Допускаются только буквы, цифры, дефисы, точки и подчёркивания

valuestring | numberrequired

Значение атрибута должно содержать не более 50 символов. В качестве значений допускаются только строки и числа с плавающей точкой

access_levelsarray of objectrequired

Массив объектов уровней доступа. Пустой массив, если у клиента нет уровней доступа

access_level_idstring

Идентификатор уровня доступа

storestring

Стор, в котором был приобретён уровень доступа

store_product_idstring

ID продукта в сторе

store_base_plan_idstring

ID базового плана в сторе

store_transaction_idstring

ID транзакции в сторе

store_original_transaction_idstring

ID исходной транзакции в сторе

offerallOf

Данные офера, если был применён promotional offer или introductory offer

categorystring

Категория офера

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Тип офера

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

ID офера

starts_atstring

Когда начинается уровень доступа

purchased_atstring

Когда был приобретён уровень доступа

originally_purchased_atstring

Когда уровень доступа был приобретён впервые

expires_atstring

Когда истекает уровень доступа

renewal_cancelled_atstring

Когда было отменено продление

billing_issue_detected_atstring

Когда была обнаружена проблема с оплатой

is_in_grace_periodboolean

Находится ли уровень доступа в льготном периоде

cancellation_reasonstring

Причина отмены

subscriptionsarray of objectrequired

Массив объектов подписок. Пустой массив, если у клиента нет подписок

storestring

Стор, в котором была приобретена подписка

store_product_idstring

ID продукта в сторе

store_base_plan_idstring

ID базового плана в сторе

store_transaction_idstring

ID транзакции в сторе

store_original_transaction_idstring

ID исходной транзакции в сторе

offerallOf

Данные офера, если был применён promotional offer или introductory offer

categorystring

Категория офера

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Тип офера

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

ID офера

environmentstring

Среда (Sandbox, Production)

purchased_atstring

Когда была приобретена подписка

originally_purchased_atstring

Когда подписка была приобретена впервые

expires_atstring

Когда истекает подписка

renewal_cancelled_atstring

Когда было отменено продление

billing_issue_detected_atstring

Когда была обнаружена проблема с оплатой

is_in_grace_periodboolean

Находится ли подписка в льготном периоде

cancellation_reasonstring

Причина отмены

non_subscriptionsarray of objectrequired

Массив объектов разовых покупок. Пустой массив, если у клиента нет покупок

purchase_idstring

Уникальный идентификатор покупки

storestring

Стор, в котором была совершена покупка

store_product_idstring

ID продукта в сторе

store_base_plan_idstring

ID базового плана в сторе

store_transaction_idstring

ID транзакции в сторе

store_original_transaction_idstring

ID исходной транзакции в сторе

purchased_atstring

Когда была совершена покупка

environmentstring

Среда (Sandbox, Production)

is_refundboolean

Является ли это возвратом средств

is_consumableboolean

Является ли это расходуемой покупкой

Example 
{
  "data": {
    "app_id": "14c3d623-2f3a-455a-aa86-ef83dff6913b",
    "profile_id": "3286abd3-48b0-4e9c-a5f6-ac0a006804a6",
    "customer_user_id": "[email protected]",
    "total_revenue_usd": 0,
    "segment_hash": "8f45947bad31ab0c",
    "timestamp": 1736425645861,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "access_levels": [],
    "subscriptions": [],
    "non_subscriptions": []
  }
}

Не авторизован

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Example 
{
  "errors": [
    {
      "source": "non_field_errors",
      "errors": [
        "Authentication credentials were not provided."
      ]
    }
  ],
  "error_code": "not_authenticated",
  "status_code": 401
}

Внутренняя ошибка сервера