PushizoDocs
API referansı

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öntemYolİşlem
GET/v1/apps/{appId}/wallet/configWallet yapılandırması
PUT/v1/apps/{appId}/wallet/configWallet kimlik bilgilerini ayarla
GET/v1/apps/{appId}/wallet/templatesWallet şablonları
POST/v1/apps/{appId}/wallet/templatesWallet ş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/passesVerilmiş kartlar
POST/v1/apps/{appId}/wallet/passesKart 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}/voidKartı iptal et

Ayrıntılar

Wallet yapılandırması

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

Kimlik bilgisi geri okunamaz, yalnızca durum döner.

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: WalletConfig

AlanTürZorunluAçıklama
appleobjectEvet
apple.configuredbooleanEvet
apple.pass_type_idstring | nullEvet
apple.team_idstring | nullEvet
apple.certificate_expires_atstring | nullEvet
googleobjectEvet
google.configuredbooleanEvet
google.issuer_idstring | nullEvet

Ö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"
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Wallet kimlik bilgilerini ayarla

PUT/v1/apps/{appId}/wallet/configDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

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

İstek gövdesi (zorunlu)

Şema: UpdateWalletConfigDto

AlanTürZorunluAçıklama
appleobject | nullHayır
googleobject | nullHayı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

AlanTürZorunluAçıklama
appleobjectEvet
apple.configuredbooleanEvet
apple.pass_type_idstring | nullEvet
apple.team_idstring | nullEvet
apple.certificate_expires_atstring | nullEvet
googleobjectEvet
google.configuredbooleanEvet
google.issuer_idstring | nullEvet

Ö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"
  }
}'
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Wallet şablonları

GET/v1/apps/{appId}/wallet/templatesDene (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: WalletTemplateList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].slugstringEvet
data[].namestringEvet
data[].kindenumEvetDeğerler: "coupon", "loyalty", "event", "generic"
data[].statusenumEvetDeğerler: "active", "archived"
data[].designobjectEvet
data[].design.titlestringEvetUzunluk: 1–100
data[].design.descriptionstringEvetUzunluk: 1–300
data[].design.organizationstringEvetUzunluk: 1–100
data[].design.background_colorstringEvetVarsayılan: "#ffffff"
data[].design.foreground_colorstringEvetVarsayılan: "#111111"
data[].design.label_colorstringEvetVarsayılan: "#555555"
data[].design.barcodeenumEvetDeğerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr"
data[].design.fieldsarray<object>EvetVarsayılan: []; Öğe: 0–12
data[].design.expires_atstring (date-time) | nullHayır
data[].design.relevant_atstring (date-time) | nullHayır
data[].imagesarray<string>Evet
data[].passesintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Ö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"
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Wallet şablonu oluştur

POST/v1/apps/{appId}/wallet/templatesDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

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

İstek gövdesi (zorunlu)

Şema: CreateWalletTemplateDto

AlanTürZorunluAçıklama
slugstringEvet
namestringEvetUzunluk: 1–100
kindenumEvetDeğerler: "coupon", "loyalty", "event", "generic"
designobjectEvet
design.titlestringEvetUzunluk: 1–100
design.descriptionstringEvetUzunluk: 1–300
design.organizationstringEvetUzunluk: 1–100
design.background_colorstringHayırVarsayılan: "#ffffff"
design.foreground_colorstringHayırVarsayılan: "#111111"
design.label_colorstringHayırVarsayılan: "#555555"
design.barcodeenumHayırDeğerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr"
design.fieldsarray<object>HayırVarsayılan: []; Öğe: 0–12
design.fields[].keystringEvet
design.fields[].labelstringHayırVarsayılan: ""; Uzunluk: 0–60
design.fields[].valuestringHayırVarsayılan: ""; Uzunluk: 0–500
design.fields[].sectionenumHayırDeğerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary"
design.expires_atstring (date-time) | nullHayır
design.relevant_atstring (date-time) | nullHayır
imagesmap<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

AlanTürZorunluAçıklama
idstringEvet
slugstringEvet
namestringEvet
kindenumEvetDeğerler: "coupon", "loyalty", "event", "generic"
statusenumEvetDeğerler: "active", "archived"
designobjectEvet
design.titlestringEvetUzunluk: 1–100
design.descriptionstringEvetUzunluk: 1–300
design.organizationstringEvetUzunluk: 1–100
design.background_colorstringEvetVarsayılan: "#ffffff"
design.foreground_colorstringEvetVarsayılan: "#111111"
design.label_colorstringEvetVarsayılan: "#555555"
design.barcodeenumEvetDeğerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr"
design.fieldsarray<object>EvetVarsayılan: []; Öğe: 0–12
design.fields[].keystringEvet
design.fields[].labelstringEvetVarsayılan: ""; Uzunluk: 0–60
design.fields[].valuestringEvetVarsayılan: ""; Uzunluk: 0–500
design.fields[].sectionenumEvetDeğerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary"
design.expires_atstring (date-time) | nullHayır
design.relevant_atstring (date-time) | nullHayır
imagesarray<string>Evet
passesintegerEvet
created_atstringEvet
updated_atstringEvet

Ö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"
  }
}'
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Wallet şablonu

GET/v1/apps/{appId}/wallet/templates/{id}Dene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

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

Yanıtlar

200 — Başarılı.

Şema: WalletTemplate

AlanTürZorunluAçıklama
idstringEvet
slugstringEvet
namestringEvet
kindenumEvetDeğerler: "coupon", "loyalty", "event", "generic"
statusenumEvetDeğerler: "active", "archived"
designobjectEvet
design.titlestringEvetUzunluk: 1–100
design.descriptionstringEvetUzunluk: 1–300
design.organizationstringEvetUzunluk: 1–100
design.background_colorstringEvetVarsayılan: "#ffffff"
design.foreground_colorstringEvetVarsayılan: "#111111"
design.label_colorstringEvetVarsayılan: "#555555"
design.barcodeenumEvetDeğerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr"
design.fieldsarray<object>EvetVarsayılan: []; Öğe: 0–12
design.fields[].keystringEvet
design.fields[].labelstringEvetVarsayılan: ""; Uzunluk: 0–60
design.fields[].valuestringEvetVarsayılan: ""; Uzunluk: 0–500
design.fields[].sectionenumEvetDeğerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary"
design.expires_atstring (date-time) | nullHayır
design.relevant_atstring (date-time) | nullHayır
imagesarray<string>Evet
passesintegerEvet
created_atstringEvet
updated_atstringEvet

Ö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"
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Wallet şablonunu güncelle

PATCH/v1/apps/{appId}/wallet/templates/{id}Dene (etkileşimli API belgesi, yeni sekme)

Tasarım değişirse verilmiş kartlar da güncellenir.

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

Parametreler

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

İstek gövdesi (zorunlu)

Şema: UpdateWalletTemplateDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 1–100
statusenumHayırDeğerler: "active", "archived"
designobjectHayır
design.titlestringEvetUzunluk: 1–100
design.descriptionstringEvetUzunluk: 1–300
design.organizationstringEvetUzunluk: 1–100
design.background_colorstringHayırVarsayılan: "#ffffff"
design.foreground_colorstringHayırVarsayılan: "#111111"
design.label_colorstringHayırVarsayılan: "#555555"
design.barcodeenumHayırDeğerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr"
design.fieldsarray<object>HayırVarsayılan: []; Öğe: 0–12
design.fields[].keystringEvet
design.fields[].labelstringHayırVarsayılan: ""; Uzunluk: 0–60
design.fields[].valuestringHayırVarsayılan: ""; Uzunluk: 0–500
design.fields[].sectionenumHayırDeğerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary"
design.expires_atstring (date-time) | nullHayır
design.relevant_atstring (date-time) | nullHayır
imagesmap<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

AlanTürZorunluAçıklama
idstringEvet
slugstringEvet
namestringEvet
kindenumEvetDeğerler: "coupon", "loyalty", "event", "generic"
statusenumEvetDeğerler: "active", "archived"
designobjectEvet
design.titlestringEvetUzunluk: 1–100
design.descriptionstringEvetUzunluk: 1–300
design.organizationstringEvetUzunluk: 1–100
design.background_colorstringEvetVarsayılan: "#ffffff"
design.foreground_colorstringEvetVarsayılan: "#111111"
design.label_colorstringEvetVarsayılan: "#555555"
design.barcodeenumEvetDeğerler: "qr", "pdf417", "aztec", "code128"; Varsayılan: "qr"
design.fieldsarray<object>EvetVarsayılan: []; Öğe: 0–12
design.fields[].keystringEvet
design.fields[].labelstringEvetVarsayılan: ""; Uzunluk: 0–60
design.fields[].valuestringEvetVarsayılan: ""; Uzunluk: 0–500
design.fields[].sectionenumEvetDeğerler: "header", "primary", "secondary", "auxiliary", "back"; Varsayılan: "secondary"
design.expires_atstring (date-time) | nullHayır
design.relevant_atstring (date-time) | nullHayır
imagesarray<string>Evet
passesintegerEvet
created_atstringEvet
updated_atstringEvet

Ö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"
  }
}'
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Wallet şablonunu sil

DELETE/v1/apps/{appId}/wallet/templates/{id}Dene (etkileşimli API belgesi, yeni sekme)

Verilmiş kartı olan şablon silinemez, arşivlenir.

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
idyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"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"
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Verilmiş kartlar

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

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
template_idsorgustringHayırUzunluk: 0–64"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitsorguintegerHayırAralık: 1–20050
cursorsorgustringHayırUzunluk: 0–64"eyJpZCI6Im1zZ18wMUpE…"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: WalletPassPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].template_idstringEvet
data[].user_idstring | nullEvet
data[].external_idstring | nullEvet
data[].barcode_valuestringEvet
data[].valuesmap<string, string>Evet
data[].statusenumEvetDeğerler: "active", "voided"
data[].urlstringEvet
data[].apple_urlstringEvet
data[].google_urlstringEvet
data[].apple_devicesintegerEvet
data[].versionintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet

Ö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"
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Kart ver

POST/v1/apps/{appId}/wallet/passesDene (etkileşimli API belgesi, yeni sekme)

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

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

İstek gövdesi (zorunlu)

Şema: IssueWalletPassDto

AlanTürZorunluAçıklama
template_idstringEvetUzunluk: 0–64
external_idstringHayırUzunluk: 1–200
barcode_valuestringHayırUzunluk: 1–500
valuesmap<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

AlanTürZorunluAçıklama
idstringEvet
template_idstringEvet
user_idstring | nullEvet
external_idstring | nullEvet
barcode_valuestringEvet
valuesmap<string, string>Evet
statusenumEvetDeğerler: "active", "voided"
urlstringEvet
apple_urlstringEvet
google_urlstringEvet
apple_devicesintegerEvet
versionintegerEvet
created_atstringEvet
updated_atstringEvet

Ö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"
  }
}'
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Kart

GET/v1/apps/{appId}/wallet/passes/{id}Dene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

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

Yanıtlar

200 — Başarılı.

Şema: WalletPass

AlanTürZorunluAçıklama
idstringEvet
template_idstringEvet
user_idstring | nullEvet
external_idstring | nullEvet
barcode_valuestringEvet
valuesmap<string, string>Evet
statusenumEvetDeğerler: "active", "voided"
urlstringEvet
apple_urlstringEvet
google_urlstringEvet
apple_devicesintegerEvet
versionintegerEvet
created_atstringEvet
updated_atstringEvet

Ö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"
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Kartı güncelle

PATCH/v1/apps/{appId}/wallet/passes/{id}Dene (etkileşimli API belgesi, yeni sekme)

Cihazdaki kart arka planda yenilenir.

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

Parametreler

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

İstek gövdesi (zorunlu)

Şema: UpdateWalletPassDto

AlanTürZorunluAçıklama
barcode_valuestringHayırUzunluk: 1–500
valuesmap<string, string>Hayır

Örnek:

{
  "barcode_value": "örnek",
  "values": {
    "key": "user_42"
  }
}

Yanıtlar

200 — Başarılı.

Şema: WalletPass

AlanTürZorunluAçıklama
idstringEvet
template_idstringEvet
user_idstring | nullEvet
external_idstring | nullEvet
barcode_valuestringEvet
valuesmap<string, string>Evet
statusenumEvetDeğerler: "active", "voided"
urlstringEvet
apple_urlstringEvet
google_urlstringEvet
apple_devicesintegerEvet
versionintegerEvet
created_atstringEvet
updated_atstringEvet

Ö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"
  }
}'
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Kartı iptal et

POST/v1/apps/{appId}/wallet/passes/{id}/voidDene (etkileşimli API belgesi, yeni sekme)

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

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

Yanıtlar

200 — Başarılı.

Şema: WalletPass

AlanTürZorunluAçıklama
idstringEvet
template_idstringEvet
user_idstring | nullEvet
external_idstring | nullEvet
barcode_valuestringEvet
valuesmap<string, string>Evet
statusenumEvetDeğerler: "active", "voided"
urlstringEvet
apple_urlstringEvet
google_urlstringEvet
apple_devicesintegerEvet
versionintegerEvet
created_atstringEvet
updated_atstringEvet

Ö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"
Sekmesi olmayan dillerde bu işlem için SDK metodu yoktur; cURL örneğini kullanın.

Bu sayfada