GET /api/v2/server-side-api/profile/

Получить профиль

Copy as Markdown

Возвращает данные существующего конечного пользователя вашего приложения.

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.

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": "14c3d333-2f3a-455a-aa86-ef83dff6913b",
    "profile_id": "d8533a10-bcce-4e33-8c9d-88b05ac56559",
    "customer_user_id": "77B14FB4-FD2A-4D38-AA3A-4C433F79863C",
    "total_revenue_usd": 9.99,
    "segment_hash": "fdaeef7f8aaa33c9",
    "timestamp": 1733324566777,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "access_levels": [
      {
        "access_level_id": "premium",
        "store": "app_store",
        "store_product_id": "unlimited.9999",
        "store_base_plan_id": null,
        "store_transaction_id": "2000000335013007",
        "store_original_transaction_id": "2000000335013007",
        "offer": null,
        "starts_at": null,
        "purchased_at": "2024-12-24T10:50:23+00:00",
        "originally_purchased_at": "2024-12-24T10:50:23+00:00",
        "expires_at": null,
        "renewal_cancelled_at": "2025-01-05T13:27:47.461425+00:00",
        "billing_issue_detected_at": null,
        "is_in_grace_period": false,
        "cancellation_reason": null
      }
    ],
    "subscriptions": [
      {
        "store": "app_store",
        "store_product_id": "unlimited.9999",
        "store_base_plan_id": null,
        "store_transaction_id": "2000000815013007",
        "store_original_transaction_id": "2000000815013007",
        "offer": null,
        "environment": "Sandbox",
        "purchased_at": "2024-12-24T10:50:23+00:00",
        "originally_purchased_at": "2024-12-24T10:50:23+00:00",
        "expires_at": null,
        "renewal_cancelled_at": null,
        "billing_issue_detected_at": null,
        "is_in_grace_period": false,
        "cancellation_reason": null
      }
    ],
    "non_subscriptions": [
      {
        "purchase_id": "7a5f9a7d-e236-33e6-96d8-53a3c59c5562",
        "store": "app_store",
        "store_product_id": "1year.premium",
        "store_base_plan_id": null,
        "store_transaction_id": "30002109551456",
        "store_original_transaction_id": "30002109551456",
        "purchased_at": "2022-10-12T09:42:50+00:00",
        "environment": "Production",
        "is_refund": false,
        "is_consumable": false
      }
    ]
  }
}

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

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
}

Профиль не найден

Schema
errorsarray of objectrequired
sourcestring

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

errorsarray of string

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

error_codestringrequired

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

status_codeintegerrequired

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

Example 
{
  "errors": [
    {
      "source": null,
      "errors": [
        "Profile not found"
      ]
    }
  ],
  "error_code": "profile_does_not_exist",
  "status_code": 404
}

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