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

Tạo hồ sơ người dùng

Tạo người dùng cuối mới trong ứng dụng của bạn trong Adapty.

Header parameters

adapty-customer-user-idstring

ID duy nhất của khách hàng trong hệ thống của bạn. Cần cung cấp adapty-customer-user-id hoặc adapty-profile-id.

adapty-profile-idstring

ID duy nhất của hồ sơ người dùng trong hệ thống của bạn. Lựa chọn tốt nhất khi làm việc với hồ sơ ẩn danh. Cần cung cấp adapty-customer-user-id hoặc adapty-profile-id.

adapty-platformstring

Nền tảng của thiết bị nơi người dùng cài đặt ứng dụng của bạn

Request body

first_namestring

Tên của người dùng cuối

last_namestring

Họ của người dùng cuối

genderstring

Giới tính của người dùng cuối

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

emailstring

Email của người dùng cuối

phone_numberstring

Số điện thoại của người dùng cuối

birthdaystring

Ngày sinh của người dùng cuối

ip_countrystring

Quốc gia của người dùng cuối theo định dạng ISO 3166-2

ip_v4_addressstring

Địa chỉ IPv4 của người dùng cuối

store_countrystring

Quốc gia của cửa hàng ứng dụng của người dùng cuối

storestring

Nền tảng người dùng sử dụng để thực hiện giao dịch mua trong ứng dụng của bạn

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

store_account_tokenstring

Token tài khoản cửa hàng

att_statusinteger

Trạng thái Apple App Tracking Transparency (0=chưa xác định, 1=bị hạn chế, 2=bị từ chối, 3=được ủy quyền)

One of: 0, 1, 2, 3

analytics_disabledboolean

Tùy chọn hủy tham gia phân tích bên ngoài

custom_attributesarray of object

Cho phép đặt tối đa 30 thuộc tính tùy chỉnh cho hồ sơ người dùng

keystringrequired

Khóa phải là chuỗi không quá 30 ký tự. Chỉ cho phép chữ cái, số, dấu gạch ngang, dấu chấm và dấu gạch dưới

valuestring | numberrequired

Giá trị thuộc tính không được quá 50 ký tự. Chỉ cho phép chuỗi và số thực làm giá trị

installation_metaobjectrequired

device_idstringrequired

Định danh thiết bị duy nhất

devicestring

Thông tin thiết bị

localestring

Ngôn ngữ thiết bị

osstring

Thông tin hệ điều hành

platformstring

Nền tảng (iOS, Android, v.v.)

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

timezonestring

Múi giờ thiết bị

user_agentstring

Chuỗi user agent

app_buildstring

Phiên bản build ứng dụng

app_versionstring

Phiên bản ứng dụng

adapty_sdk_versionstring

Phiên bản SDK Adapty

idfastring

Định danh iOS cho nhà quảng cáo

idfvstring

Định danh iOS cho nhà cung cấp

advertising_idstring

ID quảng cáo Android

android_idstring

ID thiết bị Android

android_app_set_idstring

ID bộ ứng dụng Android

Responses

Hồ sơ người dùng được tạo thành công

Schema

dataobjectrequired

app_idstringrequired

ID nội bộ của ứng dụng của bạn

profile_idstringrequired

ID hồ sơ người dùng Adapty

customer_user_idstringrequired

ID người dùng của bạn trong hệ thống của bạn

total_revenue_usdnumberrequired

Giá trị float biểu thị tổng doanh thu tính bằng USD kiếm được trong hồ sơ người dùng

segment_hashstringrequired

Tham số nội bộ

timestampintegerrequired

Thời gian phản hồi tính bằng mili giây, cần để giải quyết điều kiện tranh chấp

custom_attributesarray of objectrequired

Tối đa 30 thuộc tính tùy chỉnh được phép đặt cho hồ sơ người dùng

keystringrequired

Khóa phải là chuỗi không quá 30 ký tự. Chỉ cho phép chữ cái, số, dấu gạch ngang, dấu chấm và dấu gạch dưới

valuestring | numberrequired

Giá trị thuộc tính không được quá 50 ký tự. Chỉ cho phép chuỗi và số thực làm giá trị

access_levelsarray of objectrequired

Mảng các đối tượng mức độ truy cập. Mảng rỗng nếu khách hàng không có mức độ truy cập nào

access_level_idstring

Định danh mức độ truy cập

storestring

Cửa hàng nơi mức độ truy cập được mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

offerallOf

Thông tin ưu đãi, nếu có áp dụng ưu đãi hoặc ưu đãi giới thiệu

categorystring

Danh mục ưu đãi

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

typestring

Loại ưu đãi

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

idstring

ID ưu đãi

starts_atstring

Thời điểm mức độ truy cập bắt đầu

purchased_atstring

Thời điểm mức độ truy cập được mua

originally_purchased_atstring

Thời điểm mức độ truy cập được mua lần đầu

expires_atstring

Thời điểm mức độ truy cập hết hạn

renewal_cancelled_atstring

Thời điểm gia hạn bị hủy

billing_issue_detected_atstring

Thời điểm phát hiện vấn đề thanh toán

is_in_grace_periodboolean

Liệu mức độ truy cập có đang trong thời gian ân hạn hay không

cancellation_reasonstring

Lý do hủy

subscriptionsarray of objectrequired

Mảng các đối tượng gói đăng ký. Mảng rỗng nếu khách hàng không có gói đăng ký nào

storestring

Cửa hàng nơi gói đăng ký được mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

offerallOf

Thông tin ưu đãi, nếu có áp dụng ưu đãi hoặc ưu đãi giới thiệu

categorystring

Danh mục ưu đãi

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

typestring

Loại ưu đãi

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

idstring

ID ưu đãi

environmentstring

Môi trường (Sandbox, Production)

purchased_atstring

Thời điểm gói đăng ký được mua

originally_purchased_atstring

Thời điểm gói đăng ký được mua lần đầu

expires_atstring

Thời điểm gói đăng ký hết hạn

renewal_cancelled_atstring

Thời điểm gia hạn bị hủy

billing_issue_detected_atstring

Thời điểm phát hiện vấn đề thanh toán

is_in_grace_periodboolean

Liệu gói đăng ký có đang trong thời gian ân hạn hay không

cancellation_reasonstring

Lý do hủy

non_subscriptionsarray of objectrequired

Mảng các đối tượng sản phẩm không phải gói đăng ký. Mảng rỗng nếu khách hàng không có giao dịch mua nào

purchase_idstring

Định danh giao dịch mua duy nhất

storestring

Cửa hàng nơi thực hiện giao dịch mua

store_product_idstring

ID sản phẩm trong cửa hàng

store_base_plan_idstring

ID gói cơ bản trong cửa hàng

store_transaction_idstring

ID giao dịch trong cửa hàng

store_original_transaction_idstring

ID giao dịch gốc trong cửa hàng

purchased_atstring

Thời điểm thực hiện giao dịch mua

environmentstring

Môi trường (Sandbox, Production)

is_refundboolean

Liệu đây có phải là hoàn tiền hay không

is_consumableboolean

Liệu đây có phải là giao dịch mua consumable hay không

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": []
  }
}

Không được phép

Schema

errorsarray of objectrequired

sourcestring

Nguồn gốc lỗi

errorsarray of string

Mảng thông báo lỗi

error_codestringrequired

Tên lỗi rút gọn

status_codeintegerrequired

Mã trạng thái HTTP

Example

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

Lỗi máy chủ nội bộ

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

adapty-platform

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/profile/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Jane",
    "last_name": "Doe",
    "gender": "f",
    "email": "[email protected]",
    "phone_number": "+1234567890",
    "birthday": "2000-12-31",
    "ip_country": "FR",
    "store_country": "US",
    "store": "app_store",
    "analytics_disabled": true,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "installation_meta": {
      "device_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "device": "string",
      "locale": "en",
      "os": "string",
      "platform": "iOS",
      "timezone": "Europe/Rome",
      "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_1_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1 Mobile/15E148 Safari/604.1",
      "idfa": "EA7583CD-A667-48BC-B806-42ECB2B48333",
      "idfv": "E9D48DA5-3930-4B41-8521-D953AECD2F33",
      "advertising_id": "",
      "android_id": "",
      "android_app_set_id": ""
    }
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/profile/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "first_name": "Jane",
    "last_name": "Doe",
    "gender": "f",
    "email": "[email protected]",
    "phone_number": "+1234567890",
    "birthday": "2000-12-31",
    "ip_country": "FR",
    "store_country": "US",
    "store": "app_store",
    "analytics_disabled": true,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "installation_meta": {
      "device_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "device": "string",
      "locale": "en",
      "os": "string",
      "platform": "iOS",
      "timezone": "Europe/Rome",
      "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_1_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1 Mobile/15E148 Safari/604.1",
      "idfa": "EA7583CD-A667-48BC-B806-42ECB2B48333",
      "idfv": "E9D48DA5-3930-4B41-8521-D953AECD2F33",
      "advertising_id": "",
      "android_id": "",
      "android_app_set_id": ""
    }
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/profile/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "first_name": "Jane",
      "last_name": "Doe",
      "gender": "f",
      "email": "[email protected]",
      "phone_number": "+1234567890",
      "birthday": "2000-12-31",
      "ip_country": "FR",
      "store_country": "US",
      "store": "app_store",
      "analytics_disabled": True,
      "custom_attributes": [
        {
          "key": "favourite_sport",
          "value": "yoga"
        }
      ],
      "installation_meta": {
        "device_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "device": "string",
        "locale": "en",
        "os": "string",
        "platform": "iOS",
        "timezone": "Europe/Rome",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_1_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1 Mobile/15E148 Safari/604.1",
        "idfa": "EA7583CD-A667-48BC-B806-42ECB2B48333",
        "idfv": "E9D48DA5-3930-4B41-8521-D953AECD2F33",
        "advertising_id": "",
        "android_id": "",
        "android_app_set_id": ""
      }
    })
data = response.json()