PushizoDocs

setup

setup — 2 işlem (GET /v1/apps/{appId}/setup/status, GET /v1/apps/{appId}/setup/snippet). OpenAPI 3.1.0 sözleşmesinden üretilir.

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

İşlemler

Ayrıntılar

Kurulum durumu: platformlar, kanal durumları, ilk abone, eksik adımlar ve panel bağlantıları

GET/v1/apps/{appId}/setup/statusDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: SetupStatus

AlanTürZorunluAçıklama
app_idstringEvet
namestringEvet
platformsarray<string>Evet
frameworkstringEvet
web_integrationstringEvet
sdk_platformsarray<string>Evet
channelsarray<object>Evet
channels[].platformstringEvet
channels[].channelstringEvet
channels[].providerstring | nullEvet
channels[].statusstringEvet
first_subscriberbooleanEvet
completedbooleanEvet
missingarray<object>Evet
missing[].stepenumEvetDeğerler: "credentials", "install", "first_subscriber"
missing[].platformstringHayır
missing[].channelstringHayır
missing[].statusstringHayır
missing[].local_uploadbooleanHayır
missing[].sdk_platformsarray<string>Hayır
missing[].urlstringEvet
linksobjectEvet
links.getting_startedstringEvet
links.channelsstringEvet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "channels": [
    "web_push"
  ],
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "platforms": [
    "örnek"
  ],
  "framework": "örnek",
  "web_integration": "örnek",
  "sdk_platforms": [
    "örnek"
  ],
  "first_subscriber": true,
  "completed": true,
  "missing": [
    {
      "url": "https://pushizo.com/orders/1001",
      "step": "credentials",
      "channel": "web_push",
      "status": "örnek",
      "platform": "örnek",
      "local_upload": true
    }
  ],
  "links": {
    "channels": "örnek",
    "getting_started": "ö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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/setup/status" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

SDK kurulum kodu (panel rehberiyle aynı; platform, kod sekmesi ve not dili)

GET/v1/apps/{appId}/setup/snippetDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
platformsorguenumEvetDeğerler: "ios", "android", "flutter", "react-native", "expo", "capacitor", "cordova", "maui", "unity", "kmp", "windows", "web", "react", "nextjs", "vue", "angular", "wordpress", "gtm", "rest", "node", "php", "python", "go", "java", "csharp", "ruby", "rust""ios"
variantsorgustringHayırUzunluk: 1–40"örnek"
langsorguenumHayırDeğerler: "en", "tr""en"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: SdkSnippet

AlanTürZorunluAçıklama
platformstringEvet
variantstring | nullEvet
variantsarray<string>Evet
langstringEvet
availabilityenumEvetDeğerler: "available", "soon"
docs_pathstring | nullEvet
installarray<object>Evet
install[].keystringEvet
install[].languagestringEvet
install[].codestringEvet
initarray<object>Evet
init[].keystringEvet
init[].languagestringEvet
init[].codestringEvet
extrasarray<object>Evet
extras[].keystringEvet
extras[].languagestringEvet
extras[].codestringEvet
android_modulesarray<object>Evet
android_modules[].modulestringEvet
android_modules[].languagestringEvet
android_modules[].codestringEvet

Örnek yanıt:

{
  "platform": "örnek",
  "variant": "örnek",
  "variants": [
    "örnek"
  ],
  "lang": "tr",
  "availability": "available",
  "docs_path": "örnek",
  "install": [
    {
      "key": "key-2026-10",
      "language": "tr",
      "code": "örnek"
    }
  ],
  "init": [
    {
      "key": "key-2026-10",
      "language": "tr",
      "code": "örnek"
    }
  ],
  "extras": [
    {
      "key": "key-2026-10",
      "language": "tr",
      "code": "örnek"
    }
  ],
  "android_modules": [
    {
      "module": "örnek",
      "language": "tr",
      "code": "ö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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/setup/snippet?platform=ios" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Bu sayfada