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

Profili getir

Uygulamanızın mevcut bir son kullanıcısının ayrıntılarını getirir.

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.

Responses

Profil başarıyla getirildi

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

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
}

Profil bulunamadı

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": null,
      "errors": [
        "Profile not found"
      ]
    }
  ],
  "error_code": "profile_does_not_exist",
  "status_code": 404
}

Sunucu içi hata

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

curl --request GET \
  --url 'https://api.adapty.io/api/v2/server-side-api/profile/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/profile/', {
  method: 'GET',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
  },
});
const data = await response.json();

import requests

response = requests.get('https://api.adapty.io/api/v2/server-side-api/profile/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
})
data = response.json()