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 profiller ile çalışıyorsanız en iyi seçenektir. 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-postası

phone_numberstring

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

birthdaystring

Son kullanıcınızın doğum günü

ip_countrystring

ISO 3166-2 formatında son kullanıcının ülkesi

ip_v4_addressstring

Son kullanıcının IPv4 adresi

store_countrystring

Son kullanıcının uygulama mağazasının ülkesi

storestring

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

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

store_account_tokenstring

Mağaza hesabı token'ı

att_statusinteger

Apple Uygulama İzleme Şeffaflığı durumu (0=belirlenmedi, 1=kısıtlandı, 2=reddedildi, 3=yetkilendirildi)

One of: 0, 1, 2, 3

analytics_disabledboolean

Harici analizlerden çıkma seçeneği

custom_attributesarray of object

Profile 30'a kadar özel özellik ayarlanmasına izin verir

keystringrequired

Anahtar, 30 karakterden fazla olmayan bir dize olmalıdır. Yalnızca harfler, rakamlar, tireler, noktalar ve alt çizgiler kullanılabilir

valuestring | numberrequired

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

installation_metaobjectrequired

device_idstringrequired

Benzersiz cihaz tanımlayıcısı

devicestring

Cihaz bilgisi

localestring

Cihaz dili

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ı agent 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

Sisteminizdeki kullanıcı kimliğiniz

total_revenue_usdnumberrequired

Profilde kazanılan USD cinsinden toplam geliri temsil eden ondalık değer

segment_hashstringrequired

Dahili parametre

timestampintegerrequired

Milisaniye cinsinden yanıt süresi, bir yarış koşulunu çözmek için gereklidir

custom_attributesarray of objectrequired

Profile en fazla 30 özel özellik ayarlanmasına izin verilir

keystringrequired

Anahtar, 30 karakterden fazla olmayan bir dize olmalıdır. Yalnızca harfler, rakamlar, tireler, noktalar ve alt çizgiler kullanılabilir

valuestring | numberrequired

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

access_levelsarray of objectrequired

Access level nesneleri dizisi. Müşterinin 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

Promosyonel veya tanıtım 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 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

Faturalama sorununun tespit edildiği zaman

is_in_grace_periodboolean

Access level'ın ek sürede olup olmadığı

cancellation_reasonstring

İptal nedeni

subscriptionsarray of objectrequired

Abonelik nesneleri dizisi. Müşterinin 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

Promosyonel veya tanıtım 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ığı zaman

originally_purchased_atstring

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

expires_atstring

Aboneliğin sona erdiği zaman

renewal_cancelled_atstring

Yenilemenin iptal edildiği zaman

billing_issue_detected_atstring

Faturalama sorununun tespit edildiği zaman

is_in_grace_periodboolean

Aboneliğin ek sürede olup olmadığı

cancellation_reasonstring

İptal nedeni

non_subscriptionsarray of objectrequired

Abonelik dışı nesneler dizisi. Müşterinin satın alımı yoksa boş dizi döner

purchase_idstring

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

storestring

Satın alımı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 alımın yapıldığı zaman

environmentstring

Ortam (Sandbox, Production)

is_refundboolean

Bunun bir iade olup olmadığı

is_consumableboolean

Bunun bir consumable satın alım olup olmadığı

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

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": "[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()