wallet
wallet — 12 işlem (GET /v1/apps/{appId}/wallet/config, PUT /v1/apps/{appId}/wallet/config, GET /v1/apps/{appId}/wallet/templates, …). OpenAPI 3.1.0 sözleşmesinden üretilir.
Taban adres: https://api.pushizo.com · Etiket: wallet · Etkileşimli belge (Scalar)
İşlemler
| Yöntem | Yol | İşlem |
|---|---|---|
GET | /v1/apps/{appId}/wallet/config | Wallet yapılandırması |
PUT | /v1/apps/{appId}/wallet/config | Wallet kimlik bilgilerini ayarla |
GET | /v1/apps/{appId}/wallet/templates | Wallet şablonları |
POST | /v1/apps/{appId}/wallet/templates | Wallet şablonu oluştur |
GET | /v1/apps/{appId}/wallet/templates/{id} | Wallet şablonu |
PATCH | /v1/apps/{appId}/wallet/templates/{id} | Wallet şablonunu güncelle |
DELETE | /v1/apps/{appId}/wallet/templates/{id} | Wallet şablonunu sil |
GET | /v1/apps/{appId}/wallet/passes | Verilmiş kartlar |
POST | /v1/apps/{appId}/wallet/passes | Kart ver |
GET | /v1/apps/{appId}/wallet/passes/{id} | Kart |
PATCH | /v1/apps/{appId}/wallet/passes/{id} | Kartı güncelle |
POST | /v1/apps/{appId}/wallet/passes/{id}/void | Kartı iptal et |
Ayrıntılar
Wallet yapılandırması
Kimlik bilgisi geri okunamaz, yalnızca durum döner.
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: WalletConfig
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
apple | object | Evet | |
apple.configured | boolean | Evet | |
apple.pass_type_id | string | null | Evet | |
apple.team_id | string | null | Evet | |
apple.certificate_expires_at | string | null | Evet | |
google | object | Evet | |
google.configured | boolean | Evet | |
google.issuer_id | string | null | Evet |
Örnek yanıt:
{
"apple": {
"configured": true,
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_expires_at": "örnek"
},
"google": {
"configured": true,
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
}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/wallet/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Wallet kimlik bilgilerini ayarla
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: UpdateWalletConfigDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
apple | object | null | Hayır | |
google | object | null | Hayır |
Örnek:
{
"apple": {
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_pem": "xxxxxxxxxxxxxxxxxxxx",
"private_key_pem": "xxxxxxxxxxxxxxxxxxxx",
"wwdr_pem": "xxxxxxxxxxxxxxxxxxxx",
"key_passphrase": "örnek"
},
"google": {
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"service_account_json": "xxxxxxxxxxxxxxxxxxxx"
}
}Yanıtlar
200 — Başarılı.
Şema: WalletConfig
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
apple | object | Evet | |
apple.configured | boolean | Evet | |
apple.pass_type_id | string | null | Evet | |
apple.team_id | string | null | Evet | |
apple.certificate_expires_at | string | null | Evet | |
google | object | Evet | |
google.configured | boolean | Evet | |
google.issuer_id | string | null | Evet |
Örnek yanıt:
{
"apple": {
"configured": true,
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_expires_at": "örnek"
},
"google": {
"configured": true,
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
}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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"apple": {
"pass_type_id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"certificate_pem": "xxxxxxxxxxxxxxxxxxxx",
"private_key_pem": "xxxxxxxxxxxxxxxxxxxx",
"wwdr_pem": "xxxxxxxxxxxxxxxxxxxx",
"key_passphrase": "örnek"
},
"google": {
"issuer_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"service_account_json": "xxxxxxxxxxxxxxxxxxxx"
}
}'Wallet şablonları
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: WalletTemplateList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].slug | string | Evet | |
data[].name | string | Evet | |
data[].kind | enum | Evet | Değerler: "coupon", "loyalty", "event", "generic" |
data[].status | enum | Evet | Değerler: "active", "archived" |
data[].design | object | Evet | |
data[].design.title | string | Evet | Uzunluk: 1–100 |
data[].design.description | string | Evet | Uzunluk: 1–300 |
data[].design.organization | string | Evet | Uzunluk: 1–100 |
data[].design.background_color | string | Evet | Varsayılan: "#ffffff" |
data[].design.foreground_color | string | Evet | Varsayılan: "#111111" |
data[].design.label_color | string | Evet | Varsayılan: "#555555" |
data[].design.barcode | enum | Evet | Değerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr" |
data[].design.fields | array<object> | Evet | Varsayılan: []; Öğe: 0–12 |
data[].design.expires_at | string (date-time) | null | Hayır | |
data[].design.relevant_at | string (date-time) | null | Hayır | |
data[].images | array<string> | Evet | |
data[].passes | integer | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Örnek yanıt:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Wallet şablonu oluştur
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: CreateWalletTemplateDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
slug | string | Evet | |
name | string | Evet | Uzunluk: 1–100 |
kind | enum | Evet | Değerler: "coupon", "loyalty", "event", "generic" |
design | object | Evet | |
design.title | string | Evet | Uzunluk: 1–100 |
design.description | string | Evet | Uzunluk: 1–300 |
design.organization | string | Evet | Uzunluk: 1–100 |
design.background_color | string | Hayır | Varsayılan: "#ffffff" |
design.foreground_color | string | Hayır | Varsayılan: "#111111" |
design.label_color | string | Hayır | Varsayılan: "#555555" |
design.barcode | enum | Hayır | Değerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr" |
design.fields | array<object> | Hayır | Varsayılan: []; Öğe: 0–12 |
design.fields[].key | string | Evet | |
design.fields[].label | string | Hayır | Varsayılan: ""; Uzunluk: 0–60 |
design.fields[].value | string | Hayır | Varsayılan: ""; Uzunluk: 0–500 |
design.fields[].section | enum | Hayır | Değerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary" |
design.expires_at | string (date-time) | null | Hayır | |
design.relevant_at | string (date-time) | null | Hayır | |
images | map<string, string> | Hayır |
Örnek:
{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}Yanıtlar
201 — Başarılı.
Şema: WalletTemplate
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
slug | string | Evet | |
name | string | Evet | |
kind | enum | Evet | Değerler: "coupon", "loyalty", "event", "generic" |
status | enum | Evet | Değerler: "active", "archived" |
design | object | Evet | |
design.title | string | Evet | Uzunluk: 1–100 |
design.description | string | Evet | Uzunluk: 1–300 |
design.organization | string | Evet | Uzunluk: 1–100 |
design.background_color | string | Evet | Varsayılan: "#ffffff" |
design.foreground_color | string | Evet | Varsayılan: "#111111" |
design.label_color | string | Evet | Varsayılan: "#555555" |
design.barcode | enum | Evet | Değerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr" |
design.fields | array<object> | Evet | Varsayılan: []; Öğe: 0–12 |
design.fields[].key | string | Evet | |
design.fields[].label | string | Evet | Varsayılan: ""; Uzunluk: 0–60 |
design.fields[].value | string | Evet | Varsayılan: ""; Uzunluk: 0–500 |
design.fields[].section | enum | Evet | Değerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary" |
design.expires_at | string (date-time) | null | Hayır | |
design.relevant_at | string (date-time) | null | Hayır | |
images | array<string> | Evet | |
passes | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Örnek yanıt:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}'Wallet şablonu
Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
id | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: WalletTemplate
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
slug | string | Evet | |
name | string | Evet | |
kind | enum | Evet | Değerler: "coupon", "loyalty", "event", "generic" |
status | enum | Evet | Değerler: "active", "archived" |
design | object | Evet | |
design.title | string | Evet | Uzunluk: 1–100 |
design.description | string | Evet | Uzunluk: 1–300 |
design.organization | string | Evet | Uzunluk: 1–100 |
design.background_color | string | Evet | Varsayılan: "#ffffff" |
design.foreground_color | string | Evet | Varsayılan: "#111111" |
design.label_color | string | Evet | Varsayılan: "#555555" |
design.barcode | enum | Evet | Değerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr" |
design.fields | array<object> | Evet | Varsayılan: []; Öğe: 0–12 |
design.fields[].key | string | Evet | |
design.fields[].label | string | Evet | Varsayılan: ""; Uzunluk: 0–60 |
design.fields[].value | string | Evet | Varsayılan: ""; Uzunluk: 0–500 |
design.fields[].section | enum | Evet | Değerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary" |
design.expires_at | string (date-time) | null | Hayır | |
design.relevant_at | string (date-time) | null | Hayır | |
images | array<string> | Evet | |
passes | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Örnek yanıt:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Wallet şablonunu güncelle
Tasarım değişirse verilmiş kartlar da güncellenir.
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
id | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: UpdateWalletTemplateDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 1–100 |
status | enum | Hayır | Değerler: "active", "archived" |
design | object | Hayır | |
design.title | string | Evet | Uzunluk: 1–100 |
design.description | string | Evet | Uzunluk: 1–300 |
design.organization | string | Evet | Uzunluk: 1–100 |
design.background_color | string | Hayır | Varsayılan: "#ffffff" |
design.foreground_color | string | Hayır | Varsayılan: "#111111" |
design.label_color | string | Hayır | Varsayılan: "#555555" |
design.barcode | enum | Hayır | Değerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr" |
design.fields | array<object> | Hayır | Varsayılan: []; Öğe: 0–12 |
design.fields[].key | string | Evet | |
design.fields[].label | string | Hayır | Varsayılan: ""; Uzunluk: 0–60 |
design.fields[].value | string | Hayır | Varsayılan: ""; Uzunluk: 0–500 |
design.fields[].section | enum | Hayır | Değerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary" |
design.expires_at | string (date-time) | null | Hayır | |
design.relevant_at | string (date-time) | null | Hayır | |
images | map<string, string> | Hayır |
Örnek:
{
"name": "Sipariş bildirimleri",
"status": "active",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}Yanıtlar
200 — Başarılı.
Şema: WalletTemplate
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
slug | string | Evet | |
name | string | Evet | |
kind | enum | Evet | Değerler: "coupon", "loyalty", "event", "generic" |
status | enum | Evet | Değerler: "active", "archived" |
design | object | Evet | |
design.title | string | Evet | Uzunluk: 1–100 |
design.description | string | Evet | Uzunluk: 1–300 |
design.organization | string | Evet | Uzunluk: 1–100 |
design.background_color | string | Evet | Varsayılan: "#ffffff" |
design.foreground_color | string | Evet | Varsayılan: "#111111" |
design.label_color | string | Evet | Varsayılan: "#555555" |
design.barcode | enum | Evet | Değerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr" |
design.fields | array<object> | Evet | Varsayılan: []; Öğe: 0–12 |
design.fields[].key | string | Evet | |
design.fields[].label | string | Evet | Varsayılan: ""; Uzunluk: 0–60 |
design.fields[].value | string | Evet | Varsayılan: ""; Uzunluk: 0–500 |
design.fields[].section | enum | Evet | Değerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary" |
design.expires_at | string (date-time) | null | Hayır | |
design.relevant_at | string (date-time) | null | Hayır | |
images | array<string> | Evet | |
passes | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Örnek yanıt:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"kind": "coupon",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555",
"barcode": "qr",
"fields": [],
"expires_at": "2026-10-17T09:00:00Z",
"relevant_at": "2026-10-17T09:00:00Z"
},
"images": [
"örnek"
],
"passes": 1,
"created_at": "örnek",
"updated_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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"status": "active",
"design": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"organization": "örnek",
"background_color": "#ffffff",
"foreground_color": "#111111",
"label_color": "#555555"
},
"images": {
"key": "user_42"
}
}'Wallet şablonunu sil
Verilmiş kartı olan şablon silinemez, arşivlenir.
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
id | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
204 — Başarılı.
Gövde yok.
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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/templates/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Verilmiş kartlar
Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
template_id | sorgu | string | Hayır | Uzunluk: 0–64 | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
limit | sorgu | integer | Hayır | Aralık: 1–200 | 50 |
cursor | sorgu | string | Hayır | Uzunluk: 0–64 | "eyJpZCI6Im1zZ18wMUpE…" |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: WalletPassPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].template_id | string | Evet | |
data[].user_id | string | null | Evet | |
data[].external_id | string | null | Evet | |
data[].barcode_value | string | Evet | |
data[].values | map<string, string> | Evet | |
data[].status | enum | Evet | Değerler: "active", "voided" |
data[].url | string | Evet | |
data[].apple_url | string | Evet | |
data[].google_url | string | Evet | |
data[].apple_devices | integer | Evet | |
data[].version | integer | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet | |
next_cursor | string | null | Evet |
Örnek yanıt:
{
"data": [
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…"
}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/wallet/passes?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Kart ver
Kullanıcılı kart şablon başına tektir; tekrar istek aynı kartı döndürür.
Kimlik doğrulama: API anahtarı — kapsam notifications:write (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: IssueWalletPassDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
template_id | string | Evet | Uzunluk: 0–64 |
external_id | string | Hayır | Uzunluk: 1–200 |
barcode_value | string | Hayır | Uzunluk: 1–500 |
values | map<string, string> | Hayır |
Örnek:
{
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}Yanıtlar
201 — Başarılı.
Şema: WalletPass
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
template_id | string | Evet | |
user_id | string | null | Evet | |
external_id | string | null | Evet | |
barcode_value | string | Evet | |
values | map<string, string> | Evet | |
status | enum | Evet | Değerler: "active", "voided" |
url | string | Evet | |
apple_url | string | Evet | |
google_url | string | Evet | |
apple_devices | integer | Evet | |
version | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Örnek yanıt:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}'Kart
Kimlik doğrulama: API anahtarı — kapsam users:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
id | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: WalletPass
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
template_id | string | Evet | |
user_id | string | null | Evet | |
external_id | string | null | Evet | |
barcode_value | string | Evet | |
values | map<string, string> | Evet | |
status | enum | Evet | Değerler: "active", "voided" |
url | string | Evet | |
apple_url | string | Evet | |
google_url | string | Evet | |
apple_devices | integer | Evet | |
version | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Örnek yanıt:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Kartı güncelle
Cihazdaki kart arka planda yenilenir.
Kimlik doğrulama: API anahtarı — kapsam notifications:write (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
id | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: UpdateWalletPassDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
barcode_value | string | Hayır | Uzunluk: 1–500 |
values | map<string, string> | Hayır |
Örnek:
{
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}Yanıtlar
200 — Başarılı.
Şema: WalletPass
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
template_id | string | Evet | |
user_id | string | null | Evet | |
external_id | string | null | Evet | |
barcode_value | string | Evet | |
values | map<string, string> | Evet | |
status | enum | Evet | Değerler: "active", "voided" |
url | string | Evet | |
apple_url | string | Evet | |
google_url | string | Evet | |
apple_devices | integer | Evet | |
version | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Örnek yanıt:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"barcode_value": "örnek",
"values": {
"key": "user_42"
}
}'Kartı iptal et
Geri alınmaz; cihazdaki kart geçersiz görünür.
Kimlik doğrulama: API anahtarı — kapsam notifications:write (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
id | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: WalletPass
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
template_id | string | Evet | |
user_id | string | null | Evet | |
external_id | string | null | Evet | |
barcode_value | string | Evet | |
values | map<string, string> | Evet | |
status | enum | Evet | Değerler: "active", "voided" |
url | string | Evet | |
apple_url | string | Evet | |
google_url | string | Evet | |
apple_devices | integer | Evet | |
version | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Örnek yanıt:
{
"url": "https://pushizo.com/orders/1001",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"apple_url": "https://pushizo.com/orders/1001",
"google_url": "https://pushizo.com/orders/1001",
"apple_devices": 1,
"version": 1,
"created_at": "örnek",
"updated_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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/wallet/passes/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/void" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"feature-flags
feature-flags — 6 işlem (GET /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags/evaluate, …). OpenAPI 3.1.0 sözleşmesinden üretilir.
reverse-etl
reverse-etl — 9 işlem (GET /v1/apps/{appId}/reverse-etl, POST /v1/apps/{appId}/reverse-etl, POST /v1/apps/{appId}/reverse-etl/test-connection, …). OpenAPI 3.1.0 sözleşmesinden üretilir.