SDK uçları (istemci)

İstemci SDK’larının kullandığı uçlar. API anahtarı yerine sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT) ile çalışır; tarayıcı/cihazdan doğrudan çağrılır.

Taban adres: https://api.pushizo.com · Etiket: sdk · Etkileşimli belge (Scalar)

İşlemlerBağlantıyı kopyala

AyrıntılarBağlantıyı kopyala

SDK için public app yapılandırmasıBağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkConfig

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "api_url": "https://example.com/orders/1001",
  "cell_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_verification_required": true,
  "identity_verification_mode": "hmac",
  "platforms": {
    "ios": true,
    "android": true,
    "web": true,
    "email": true,
    "sms": true
  },
  "web": {
    "vapid_public_key": "örnek",
    "allowed_origins": [
      "örnek"
    ],
    "service_worker_path": "örnek",
    "service_worker_scope": "örnek",
    "prompt": {
      "type": "slidedown",
      "enabled": true,
      "collect": "push",
      "delaySeconds": 1
    },
    "welcome_notification": {
      "enabled": true,
      "url": "https://example.com/orders/1001",
      "texts": {
        "key": {
          "title": "Siparişiniz yola çıktı"
        }
      }
    },
    "click_behavior": {
      "match": "exact",
      "action": "navigate"
    },
    "custom_link": {
      "enabled": true,
      "style": "button",
      "size": "small",
      "color": {
        "button": "örnek"
      },
      "texts": {
        "key": {
          "subscribe": "örnek"
        }
      }
    },
    "prompt_backoff_days": [
      1
    ]
  },
  "session": {
    "timeout_seconds": 1
  },
  "in_app": {
    "min_interval_seconds": 1
  },
  "android_channels": [
    {
      "name": "Sipariş bildirimleri",
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "description": "Sipariş durumu güncellemeleri",
      "importance": "low",
      "sound": "örnek",
      "vibration": true,
      "group": "orders"
    }
  ],
  "categories": [
    {
      "name": {
        "key": "user_42"
      },
      "channels": [
        "web_push"
      ],
      "key": "key-2026-10",
      "description": {
        "key": "user_42"
      },
      "default_opted_in": true
    }
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/config"

Cihaz/kanal kaydı (idempotent: aynı token tek abonelik)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkRegisterDto

Örnek:

{
  "channel": "ios_push",
  "token": "d1f2e3…",
  "device": {},
  "test_device": true,
  "user": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "properties": {
      "order_id": "1001"
    },
    "external_id": "user_42"
  },
  "ownership_proof": true
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkRegisterResult

Örnek yanıt:

{
  "status": "subscribed",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "created": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "ios_push",
  "token": "d1f2e3…",
  "device": {},
  "test_device": true,
  "user": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "properties": {
      "order_id": "1001"
    },
    "external_id": "user_42"
  },
  "ownership_proof": true
}'

Token yenileme, cihaz bilgisi, opt-in/out (sahiplik kanıtı: token_hash veya identity_hash)Bağlantıyı kopyala

Kanıt, kayıtlı token'ın SHA-256 özeti (token_hash) veya abonelik kullanıcısının identity_hash'idir. Push aboneliğinde ownership_proof: true ile kaydolmuş ya da bir kez geçerli kanıt göndermiş abonelikte zorunludur; e-posta/SMS aboneliğinde her zaman zorunludur. Yanlış kanıt 403 (ADR-0016).

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkSubscriptionPatchDto

Örnek:

{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "token": "d1f2e3…",
  "device": {
    "model": "örnek",
    "os": "örnek",
    "os_version": "örnek"
  },
  "opted_in": true
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Subscription

Örnek yanıt:

{
  "channel": "ios_push",
  "status": "subscribed",
  "id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token": "d1f2e3…",
  "unsubscribe_reason": "provider_rejected",
  "device": {
    "model": "örnek",
    "os": "örnek",
    "os_version": "örnek",
    "app_version": "örnek"
  },
  "test_device": true,
  "test_device_name": "örnek",
  "last_active_at": "örnek",
  "last_sent_at": "örnek",
  "last_delivered_at": "örnek",
  "opted_in_at": "örnek",
  "opt_in_source": "örnek",
  "unsubscribed_at": "örnek",
  "location": {
    "lat": 1.5,
    "lng": 1.5,
    "accuracy_m": 1.5,
    "geohash": "örnek",
    "updated_at": "örnek",
    "consent_at": "örnek"
  },
  "created_at": "örnek"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X PATCH "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Content-Type: application/json" \
  -d '{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "token": "d1f2e3…",
  "device": {
    "model": "örnek",
    "os": "örnek",
    "os_version": "örnek"
  },
  "opted_in": true
}'

Aboneliği sil (sahiplik kanıtı: token_hash veya identity_hash)Bağlantıyı kopyala

Kanıt kuralları PATCH ile aynıdır (ADR-0016).

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Cihazı external_id ile kullanıcıya bağla (anonim kullanıcı birleştirilir; sahiplik kanıtı: token_hash)Bağlantıyı kopyala

Sahiplik kanıtı token_hash (kayıtlı token'ın SHA-256 özeti); identity_hash yalnızca abonelik zaten aynı external_id ile bağlıysa kanıt sayılır. Kurallar PATCH ile aynıdır (ADR-0016).

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkLoginDto

Örnek:

{
  "external_id": "user_42",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkUserResult

Örnek yanıt:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/login" \
  -H "Content-Type: application/json" \
  -d '{
  "external_id": "user_42",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}'

Cihazı anonim yeni kullanıcıya taşı (sahiplik kanıtı: token_hash veya identity_hash)Bağlantıyı kopyala

Kanıt kuralları PATCH ile aynıdır (ADR-0016); gövde boş gönderilebilir.

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (isteğe bağlı)

Şema: SdkLogoutDto

Örnek:

{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkUserResult

Örnek yanıt:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/logout" \
  -H "Content-Type: application/json" \
  -d '{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

Tag/property merge-patch (identity verification zorunluysa hash gerekir)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkUserPatchDto

Örnek:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "properties": {
    "order_id": "1001"
  },
  "deltas": {
    "session_count": 1,
    "session_time": 1,
    "purchases": [
      {
        "sku": "örnek",
        "amount": 149.9,
        "iso": "örnek"
      }
    ]
  },
  "identity_hash": "3f6c…b1e9"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkUserResult

Örnek yanıt:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X PATCH "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Content-Type: application/json" \
  -d '{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "properties": {
    "order_id": "1001"
  },
  "deltas": {
    "session_count": 1,
    "session_time": 1,
    "purchases": [
      {
        "sku": "örnek",
        "amount": 149.9,
        "iso": "örnek"
      }
    ]
  },
  "identity_hash": "3f6c…b1e9"
}'

Kullanıcıya alias ekle (User.addAlias; identity verification zorunluysa hash)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkIdentityDto

Örnek:

{
  "identity": {
    "external_id": [
      "user_42"
    ]
  },
  "identity_hash": "3f6c…b1e9"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkIdentityResult

Örnek yanıt:

{
  "identity": {
    "external_id": [
      "user_42"
    ]
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X PATCH "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/identity" \
  -H "Content-Type: application/json" \
  -d '{
  "identity": {
    "external_id": [
      "user_42"
    ]
  },
  "identity_hash": "3f6c…b1e9"
}'

Kullanıcıdan alias kaldır (User.removeAlias)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkIdentityResult

Örnek yanıt:

{
  "identity": {
    "external_id": [
      "user_42"
    ]
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/identity/external_id"

Oturum başlangıcı (süre yoksa) veya bitişi (süre ile; sahiplik kanıtı: token_hash veya identity_hash)Bağlantıyı kopyala

subscription_id aboneliği için kanıt kuralları PATCH ile aynıdır (ADR-0016).

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkSessionDto

Örnek:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "duration_seconds": 1,
  "app_version": "örnek",
  "sdk_version": "örnek"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/sessions" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "duration_seconds": 1,
  "app_version": "örnek",
  "sdk_version": "örnek"
}'

Toplu olay bildirimi (en fazla 100)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkEventsDto

Örnek:

{
  "events": [
    {
      "name": "purchase",
      "properties": {},
      "value": 149.9,
      "occurred_at": "2026-10-17T09:00:00Z"
    }
  ]
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: EventsAccepted

Örnek yanıt:

{
  "accepted": 1
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
  -H "Content-Type: application/json" \
  -d '{
  "events": [
    {
      "name": "purchase",
      "properties": {},
      "value": 149.9,
      "occurred_at": "2026-10-17T09:00:00Z"
    }
  ]
}'

Cihaz bildirimi aldı (confirmed delivery)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/received"

Bildirim kullanıcı tarafından kapatıldı (web notificationclose, Android silme)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/dismissed"

Bildirim açıldı / düğmeye tıklandıBağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: OpenedDto

Örnek:

{
  "button_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/opened" \
  -H "Content-Type: application/json" \
  -d '{
  "button_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Live Activity belirteci kaydet (push-to-start veya etkinlik güncelleme)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkLiveActivityTokenDto

Örnek:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "token": "d1f2e3…",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: LiveActivityTokenResult

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/tokens" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "token": "d1f2e3…",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

Live Activity belirtecini sil (etkinlik bitti veya izin kaldırıldı)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkLiveActivityTokenDeleteDto

Örnek:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: LiveActivityTokenResult

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/tokens/delete" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

SDK hata raporları (en fazla 20; 7 gün saklanır)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkErrorsDto

Örnek:

{
  "errors": [
    {
      "platform": "web",
      "message": "Takip bağlantısı içeride",
      "level": "error",
      "sdk_version": "örnek",
      "code": "örnek"
    }
  ]
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkErrorsAccepted

Örnek yanıt:

{
  "accepted": 1
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/errors" \
  -H "Content-Type: application/json" \
  -d '{
  "errors": [
    {
      "platform": "web",
      "message": "Takip bağlantısı içeride",
      "level": "error",
      "sdk_version": "örnek",
      "code": "örnek"
    }
  ]
}'

Cihaz için gösterilebilecek in-app mesajlar (tetikleri SDK değerlendirir)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkInAppList

Örnek yanıt:

{
  "data": [
    {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "priority": 10,
      "triggers": [
        {
          "kind": "session_start"
        }
      ],
      "trigger_groups": [
        [
          {}
        ]
      ],
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "display": {
        "layout": "modal",
        "background_color": "örnek",
        "text_color": "örnek",
        "dismissible": true,
        "auto_dismiss_seconds": 1,
        "content_type": "blocks",
        "html": "örnek",
        "html_height": 1,
        "blocks": [
          {}
        ]
      },
      "remaining_impressions": 1,
      "min_interval_seconds": 1,
      "stop_after_interaction": true,
      "last_impression_at": "örnek",
      "end_at": "örnek"
    }
  ],
  "language": "tr"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

In-app gösterim / tıklama / kapatmaBağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkInAppEventDto

Örnek:

{
  "type": "impression",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "impression",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Bildirim kutusu (abonelik kullanıcıya ait olmalı; gerekirse identity_hash)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: InboxPage

Örnek yanıt:

{
  "data": [
    {
      "url": "https://example.com/orders/1001",
      "data": {
        "order_id": "1001"
      },
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "title": "Siparişiniz yola çıktı",
      "body": "Takip bağlantısı içeride",
      "image_url": "https://example.com/orders/1001",
      "read": true,
      "read_at": "örnek",
      "archived_at": "örnek",
      "expires_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "unread_count": 1,
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox?limit=50&subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Tümünü okundu işaretleBağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkInboxActionDto

Örnek:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: InboxReadAllResult

Örnek yanıt:

{
  "updated": 1,
  "unread_count": 1
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/read-all" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}'

Okundu işaretleBağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkInboxActionDto

Örnek:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: InboxItem

Örnek yanıt:

{
  "url": "https://example.com/orders/1001",
  "data": {
    "order_id": "1001"
  },
  "id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "title": "Siparişiniz yola çıktı",
  "body": "Takip bağlantısı içeride",
  "image_url": "https://example.com/orders/1001",
  "read": true,
  "read_at": "örnek",
  "archived_at": "örnek",
  "expires_at": "örnek",
  "created_at": "örnek"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W/read" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}'

Kutudan kaldır (arşivle)Bağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Cihaz kullanıcısının tercihleri ve kategorilerBağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkPreferences

Örnek yanıt:

{
  "data": [
    {
      "channel": "web_push",
      "category": "örnek",
      "opted_in": true,
      "explicit": true,
      "source": "örnek",
      "updated_at": "örnek"
    }
  ],
  "categories": [
    {
      "name": {
        "key": "user_42"
      },
      "channels": [
        "web_push"
      ],
      "key": "key-2026-10",
      "description": {
        "key": "user_42"
      },
      "default_opted_in": true
    }
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/preferences?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Cihaz kullanıcısının tercihlerini yazBağlantıyı kopyala

Kimlik doğrulama: API anahtarı gerekmez; sahiplik kanıtı (token_hash) ve zorunluysa identity verification (identity_hash veya JWT). Ayrıntı: SDK kimliği.

Parametreler

İstek gövdesi (zorunlu)

Şema: SdkSetPreferencesDto

Örnek:

{
  "preferences": [
    {
      "category": "örnek",
      "opted_in": true,
      "channel": "ios_push"
    }
  ],
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SdkPreferences

Örnek yanıt:

{
  "data": [
    {
      "channel": "web_push",
      "category": "örnek",
      "opted_in": true,
      "explicit": true,
      "source": "örnek",
      "updated_at": "örnek"
    }
  ],
  "categories": [
    {
      "name": {
        "key": "user_42"
      },
      "channels": [
        "web_push"
      ],
      "key": "key-2026-10",
      "description": {
        "key": "user_42"
      },
      "default_opted_in": true
    }
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X PUT "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/preferences" \
  -H "Content-Type: application/json" \
  -d '{
  "preferences": [
    {
      "category": "örnek",
      "opted_in": true,
      "channel": "ios_push"
    }
  ],
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'