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

Profil oluştur

Adapty'de uygulamanızın yeni bir son kullanıcısını oluşturur.

Header parameters

adapty-customer-user-idstring

Sisteminizdeki müşterinin benzersiz kimliği. adapty-customer-user-id veya adapty-profile-id alanlarından biri zorunludur.

adapty-profile-idstring

Sisteminizdeki profilin benzersiz kimliği. Anonim profillerle çalışıyorsanız en iyi seçeneğinizdir. adapty-customer-user-id veya adapty-profile-id alanlarından biri zorunludur.

adapty-platformstring

Kullanıcının uygulamanızın yüklü olduğu cihazın platformu

Request body

first_namestring

Son kullanıcınızın adı

last_namestring

Son kullanıcınızın soyadı

genderstring

Son kullanıcınızın cinsiyeti

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

emailstring

Son kullanıcınızın e-posta adresi

phone_numberstring

Son kullanıcınızın telefon numarası

birthdaystring

Son kullanıcınızın doğum tarihi

ip_countrystring

Son kullanıcının ülkesi, iki harfli ISO 3166-1 alfa-2 kodu olarak, örneğin FR

ip_v4_addressstring

Son kullanıcının IPv4 adresi

store_countrystring

Son kullanıcının uygulama mağazasının ülkesi, iki harfli ISO 3166-1 alfa-2 kodu olarak, örneğin US

storestring

Kullanıcının uygulamanızda satın alma işlemi yapmak için kullandığı platform

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

store_account_tokenstring

Mağaza hesap token'ı

att_statusinteger

Apple App Tracking Transparency durumu (0=belirlenmedi, 1=kısıtlı, 2=reddedildi, 3=onaylandı)

One of: 0, 1, 2, 3

analytics_disabledboolean

Harici analizlerden çıkma seçeneği

custom_attributesarray of object

Profil için 30'a kadar özel nitelik ayarlamaya olanak tanır

keystringrequired

Anahtar, 30 karakterden fazla olmayan bir dize olmalıdır. Yalnızca harflere, sayılara, tire, nokta ve alt çizgilere izin verilir

valuestring | numberrequired

Özellik değeri 50 karakterden fazla olmamalıdır. Değer olarak yalnızca dizeler ve kayan noktalı sayılara izin verilir

installation_metaobjectrequired

device_idstringrequired

Benzersiz cihaz tanımlayıcısı

devicestring

Cihaz bilgisi

localestring

Cihaz yerel ayarı

osstring

İşletim sistemi bilgisi

platformstring

Platform (iOS, Android vb.)

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

timezonestring

Cihaz saat dilimi

user_agentstring

Kullanıcı ajan dizesi

app_buildstring

Uygulama derleme sürümü

app_versionstring

Uygulama sürümü

adapty_sdk_versionstring

Adapty SDK sürümü

idfastring

iOS Reklamverenler için Tanımlayıcı

idfvstring

iOS Satıcı için Tanımlayıcı

advertising_idstring

Android reklam kimliği

android_idstring

Android cihaz kimliği

android_app_set_idstring

Android uygulama seti kimliği

Responses

Profil başarıyla oluşturuldu

Schema

dataobjectrequired

app_idstringrequired

Uygulamanızın dahili kimliği

profile_idstringrequired

Adapty profil kimliği

customer_user_idstringrequired

Kullanıcınızın kendi sisteminizdeki kimliği

total_revenue_usdnumberrequired

Profilde elde edilen toplam geliri USD cinsinden temsil eden ondalık sayı değeri

segment_hashstringrequired

Dahili parametre

timestampintegerrequired

Yarış koşulunu çözmek için gereken milisaniye cinsinden yanıt süresi

custom_attributesarray of objectrequired

Profile en fazla 30 özel öznitelik eklenebilir

keystringrequired

Anahtar, 30 karakterden fazla olmayan bir dize olmalıdır. Yalnızca harflere, sayılara, tire, nokta ve alt çizgilere izin verilir

valuestring | numberrequired

Özellik değeri 50 karakterden fazla olmamalıdır. Değer olarak yalnızca dizeler ve kayan noktalı sayılara izin verilir

access_levelsarray of objectrequired

Access level nesnelerinin dizisi. Müşterinin herhangi bir access level'ı yoksa boş dizi döner

access_level_idstring

Access level tanımlayıcısı

storestring

Access level'ın satın alındığı mağaza

store_product_idstring

Mağazadaki ürün kimliği

store_base_plan_idstring

Mağazadaki temel plan kimliği

store_transaction_idstring

Mağazadaki işlem kimliği

store_original_transaction_idstring

Mağazadaki orijinal işlem kimliği

offerallOf

Promosyon teklifi veya başlangıç teklifi uygulandıysa teklif ayrıntıları

categorystring

Teklif kategorisi

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

typestring

Teklif türü

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

idstring

Teklif kimliği

starts_atstring

Access level'ın başladığı zaman

purchased_atstring

Access level'ın satın alındığı zaman

originally_purchased_atstring

Access level'ın ilk kez satın alındığı zaman

expires_atstring

Access level'ın sona erdiği zaman

renewal_cancelled_atstring

Yenilemenin iptal edildiği zaman

billing_issue_detected_atstring

Ödeme sorununun tespit edildiği zaman

is_in_grace_periodboolean

Access level'ın ek süre içinde olup olmadığı

cancellation_reasonstring

İptal gerekçesi

subscriptionsarray of objectrequired

Abonelik nesnelerinin dizisi. Müşterinin herhangi bir aboneliği yoksa boş dizi döner

storestring

Aboneliğin satın alındığı mağaza

store_product_idstring

Mağazadaki ürün kimliği

store_base_plan_idstring

Mağazadaki temel plan kimliği

store_transaction_idstring

Mağazadaki işlem kimliği

store_original_transaction_idstring

Mağazadaki orijinal işlem kimliği

offerallOf

Bir promosyon teklifi veya başlangıç teklifi uygulandıysa teklif ayrıntıları

categorystring

Teklif kategorisi

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

typestring

Teklif türü

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

idstring

Teklif kimliği

environmentstring

Ortam (Sandbox, Production)

purchased_atstring

Aboneliğin satın alındığı tarih

originally_purchased_atstring

Aboneliğin ilk satın alındığı tarih

expires_atstring

Aboneliğin sona erdiği tarih

renewal_cancelled_atstring

Yenilemenin iptal edildiği tarih

billing_issue_detected_atstring

Faturalama sorununun tespit edildiği tarih

is_in_grace_periodboolean

Aboneliğin ek süre içinde olup olmadığı

cancellation_reasonstring

İptal nedeni

non_subscriptionsarray of objectrequired

Tek seferlik satın alma nesnelerinin dizisi. Müşterinin herhangi bir satın alımı yoksa boş dizi döner

purchase_idstring

Benzersiz satın alma tanımlayıcısı

storestring

Satın almanın yapıldığı mağaza

store_product_idstring

Mağazadaki ürün kimliği

store_base_plan_idstring

Mağazadaki temel plan kimliği

store_transaction_idstring

Mağazadaki işlem kimliği

store_original_transaction_idstring

Mağazadaki orijinal işlem kimliği

purchased_atstring

Satın almanın yapıldığı zaman

environmentstring

Ortam (Sandbox, Production)

is_refundboolean

Bunun bir iade olup olmadığı

is_consumableboolean

Bunun bir consumable satın alma olup olmadığı

Example

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

Yetkisiz

Schema

errorsarray of objectrequired

sourcestring

Hatanın kaynağı

errorsarray of string

Hata mesajları dizisi

error_codestringrequired

Kısa hata adı

status_codeintegerrequired

HTTP durum kodu

Example

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

Sunucu içi hata

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": "jane.doe@example.com",
    "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": "jane.doe@example.com",
    "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": "jane.doe@example.com",
      "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()