T-SOFT/Storefront API/Kayıt Form Alanları

Kayıt Form Alanları

Yetki:storefront:read — herkese açık, token isteğe bağlı.

Mağazanın üye kayıt formunu hangi alanlardan kuracağınızı döner: her alanın etiketi, anahtarı, girdi tipi, zorunluluğu, seçenek listesi ve sıra numarası. Bu uç girişsiz erişilebilir olduğundan, müşteri henüz giriş yapmadan kayıt formunu dinamik olarak kurabilirsiniz. Kaynak salt okunurdur.

Profil düzenleme ve bayi kayıt formlarının alanları ise giriş yapmış müşteri token'ıyla Müşteri Form Alanları kaynağından alınır.

Listeleme

GET /customer-form-fields

filter[formType]=register zorunludur:

curl "https://<domain>/api/v3/storefront/2026-01/customer-form-fields?filter[formType]=register" \
  -H "Accept: application/vnd.api+json"

Token gönderilebilir ama gerekli değildir; uygulama token'ıyla da anonim de çalışır.

{
  "jsonapi": { "version": "1.0" },
  "data": [
    {
      "type": "customer-form-fields",
      "id": "1",
      "attributes": {
        "title": "Ad",
        "fieldKey": "ad",
        "fieldType": "INPUT",
        "isRequired": true,
        "options": [],
        "minLength": 0,
        "maxLength": 0,
        "listNo": 1
      },
      "links": { "self": "https://<domain>/api/v3/storefront/2026-01/customer-form-fields/1" }
    },
    {
      "type": "customer-form-fields",
      "id": "2",
      "attributes": {
        "title": "Soyad",
        "fieldKey": "soyad",
        "fieldType": "INPUT",
        "isRequired": true,
        "options": [],
        "minLength": 0,
        "maxLength": 0,
        "listNo": 2
      }
    }
  ]
}

Liste sayfalanmaz — kayıt formunun tüm alanları tek yanıtta, varsayılan olarak listNo artan sırayla döner.

Filtreler

Parametre	Örnek	Davranış
`filter[formType]`	`filter[formType]=register`	Zorunlu. Bu genel uçta yalnızca `register` (üye kaydı) kabul edilir; başka bir değer `403` döner.
`filter[platform]`	`filter[platform]=mobileApp`	Platform hedefi: `web` veya `mobileApp`. `mobileApp` dışındaki her değer `web` olarak yorumlanır.
`filter[id]`	`filter[id]=1,2`	Virgülle ayrılmış alan id listesi; yalnızca eşleşen alanları döndürür.

Sıralama

Parametre	Örnek	Davranış
`sort`	`sort=listNo` / `sort=-listNo`	Panelde tanımlı görüntüleme sırasına göre; varsayılan `listNo` artan.

Alanlar

Alan	Tip	Kural
`title`	string	Alanın formda görüntülenecek etiketi (mağaza dilinde).
`fieldKey`	string	Alanın makine anahtarı (örn. `ad`, `soyad`, `ceptel`, `eposta`, `firma`, `vergino`). Bölge alanları normalize edilir: `country_code`, `city_code`, `town_code`, `district`.
`fieldType`	string	Girdi tipi: `INPUT`, `TEXTAREA`, `SELECT_BOX`, `RADIO`, `CHECK_BOX`, `NOTE`, `FILE`. Bilinmeyen tip `INPUT` olarak döner.
`isRequired`	bool	`true` ise form gönderiminde alan zorunlu tutulmalıdır.
`options`	string	`SELECT_BOX` / `RADIO` tipleri için seçenek listesi; diğer tiplerde boş dizi.
`minLength`	int	En az karakter sayısı; `0` = sınır yok.
`maxLength`	int	En çok karakter sayısı; `0` = sınır yok.
`listNo`	int	Formdaki görüntüleme sırası.

formType semantiği

Bu genel uç yalnızca kayıt formunu döndürmek için tasarlanmıştır; bu yüzden filter[formType] zorunludur ve register dışında bir değer 403 ("Insufficient scope.") verir. Kayıt formunu kurduktan sonra, alan anahtarlarını doğrudan kayıt isteğinin gövdesine eşleyebilirsiniz — bkz. Üye Kaydı ve Parola Kurtarma.

Hatalar

Durum kodu	Sebep
400	`filter[formType]` gönderilmedi
403	`filter[formType]` `register` dışında bir değer taşıyor
406	`Accept` başlığı `application/vnd.api+json` değil