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
| Yöntem | Yol | İşlem |
|---|---|---|
GET | /v1/apps/{appId}/setup/status | Kurulum durumu: platformlar, kanal durumları, ilk abone, eksik adımlar ve panel bağlantıları |
GET | /v1/apps/{appId}/setup/snippet | SDK kurulum kodu (panel rehberiyle aynı; platform, kod sekmesi ve not dili) |
Ayrıntılar
Kurulum durumu: platformlar, kanal durumları, ilk abone, eksik adımlar ve panel bağlantıları
Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: SetupStatus
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
app_id | string | Evet | |
name | string | Evet | |
platforms | array<string> | Evet | |
framework | string | Evet | |
web_integration | string | Evet | |
sdk_platforms | array<string> | Evet | |
channels | array<object> | Evet | |
channels[].platform | string | Evet | |
channels[].channel | string | Evet | |
channels[].provider | string | null | Evet | |
channels[].status | string | Evet | |
first_subscriber | boolean | Evet | |
completed | boolean | Evet | |
missing | array<object> | Evet | |
missing[].step | enum | Evet | Değerler: "credentials", "install", "first_subscriber" |
missing[].platform | string | Hayır | |
missing[].channel | string | Hayır | |
missing[].status | string | Hayır | |
missing[].local_upload | boolean | Hayır | |
missing[].sdk_platforms | array<string> | Hayır | |
missing[].url | string | Evet | |
links | object | Evet | |
links.getting_started | string | Evet | |
links.channels | string | Evet |
Ö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)
Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
platform | sorgu | enum | Evet | Değ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" |
variant | sorgu | string | Hayır | Uzunluk: 1–40 | "örnek" |
lang | sorgu | enum | Hayır | Değerler: "en", "tr" | "en" |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: SdkSnippet
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
platform | string | Evet | |
variant | string | null | Evet | |
variants | array<string> | Evet | |
lang | string | Evet | |
availability | enum | Evet | Değerler: "available", "soon" |
docs_path | string | null | Evet | |
install | array<object> | Evet | |
install[].key | string | Evet | |
install[].language | string | Evet | |
install[].code | string | Evet | |
init | array<object> | Evet | |
init[].key | string | Evet | |
init[].language | string | Evet | |
init[].code | string | Evet | |
extras | array<object> | Evet | |
extras[].key | string | Evet | |
extras[].language | string | Evet | |
extras[].code | string | Evet | |
android_modules | array<object> | Evet | |
android_modules[].module | string | Evet | |
android_modules[].language | string | Evet | |
android_modules[].code | string | Evet |
Ö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"