Registration Form için API’ler

Bu sayfa, Registration Form’ları (toptan müşterilerinizin gönderdiği kayıt formları) yönetmek için Public API’yi kapsar. 4 işlemin tamamı, Genel API’ler sayfasında açıklanan aynı temel URL’yi, üstbilgileri ve kimlik doğrulamayı paylaşır.

Not

Bir Registration Form’un alan düzeni (elements) karmaşık olabilir. Sıfırdan bir istek oluşturmadan önce, beklenen yapının gerçek bir örneğini görmek için uygulamada oluşturduğunuz mevcut bir form üzerinde GET kullanmanızı, ardından yalnızca ihtiyacınız olanı ayarlamanızı öneririz.

Registration Form oluşturma

Uç nokta

POST https://wholesale.samita.io/api/v1/registration-forms

İstek üstbilgileri

Üstbilgi	Açıklama	Zorunlu
X-SAMITA-API-KEY	Wholesale uygulamasında sağlanan API anahtarı	Evet
X-SAMITA-SHOP-URL	xxx.myshopify.com biçiminde Shopify mağaza alan adı	Evet
CONTENT-TYPE	application/json olmalıdır	Evet

Bu API, API anahtarında Create izni gerektirir.

İstek gövdesi

Üst düzey alanlar:

Alan	Tür	Zorunlu	Açıklama
title	string	Önerilir	Formun uygulamadaki adı.
status	boolean	Önerilir	Formun etkin olup olmadığı.
shopify_integration	object	Evet	Gönderimlerin Shopify müşterileriyle nasıl bağlanacağını denetler; aşağıya bakın.
elements	array	Evet	Formun alanları, görüntülenme sırasıyla; aşağıya bakın.
header	object	Hayır	Formun üstünde gösterilen başlık metni.
footer	object	Hayır	Formun altında gösterilen alt bilgi düğmeleri ve metni.
general	object	Hayır	Onay davranışı ve varsayılan müşteri etiketleri.
errorMessage	object	Hayır	Özel doğrulama hata metni.
reCaptcha	object	Hayır	Bu formda reCAPTCHA’nın zorunlu olup olmadığı.
afterSubmit	object	Hayır	Bir müşteri gönderdikten sonra ne olacağı.

shopify_integration

Alan	Tür	Notlar
ifExist	string (zorunlu)	returnError, continueAndUpdate veya continueAndIgnoreError: gönderilen e-postanın zaten bir müşteri hesabı varsa ne olacağı.
showMessage	boolean	Müşteriyi bunun yerine giriş yapmaya yönlendiren bir mesaj gösterir.
messageRedirectToLogin	string	Bu mesajın metni.
sendEmailInvite	boolean	Shopify’ın hesap etkinleştirme e-postasını gönderir.
acceptsMarketing	boolean	Yeni müşteriyi pazarlama e-postalarına dahil eder.

elements (alan nesneleri dizisi)

Her öğenin bir type değeri olmalıdır; yaygın türler arasında text, email, phone, password, number, name, url, checkbox, radio, country, datetime, file, hidden, heading, paragraph, devider ve html bulunur.

Alan	Tür	Geçerli olduğu türler	Notlar
type	string (zorunlu)	tümü	Öğe türü.
columnWidth	number (devider hariç zorunlu)	tümü	33.33, 50 veya 100.
label / placeholder / description	string	giriş türleri	Alan etiketleme.
required	boolean (heading, paragraph, devider, html için zorunlu)	bu türler	Alanın doldurulmasının zorunlu olup olmadığı.
hasConfirm, labelConfirm, placeholderConfirm, descriptionConfirm	—	password	Parola doğrulama alanı ekler.
options, defaultOptions, defaultOption, defaultSelected	—	checkbox, radio, country	Seçenek listesi yapılandırması.
inlineOption	number (zorunlu)	checkbox, radio	20, 25, 33.33, 50 veya 100.
heading / text	string	heading / paragraph	Görüntülenen içerik.
html	string	html	Ham HTML bloğu.
allowed-multiple	boolean	file	Birden fazla dosya yüklemeye izin verir.
allowed-extension	array	file	Şunlardan herhangi biri: csv, pdf, jpg, jpeg, gif, svg, png, psd, ai, stl, stp, step, doc, docx, txt, ex2, dxf, gbr, eps, mov, mp4, xls, xlsx, ods, numbers, xlsm, zip, heic, heif.
format, date-format, time-format	string	datetime	format: date/time/date-and-time. date-format: Y-m-d/d-m-Y/m-d-Y/d-m/m-d. time-format: 12h/24h.
integration	string	herhangi biri	Bu alanı bir Shopify müşteri özelliğiyle eşler: email, phone, first_name, last_name, addresses.address1, addresses.address2, addresses.city, addresses.province, addresses.zip, addresses.company, addresses.country, password, tags[] veya note[].

header, footer, general, errorMessage, reCaptcha, afterSubmit

Bölüm	Alan	Tür	Notlar
header	active	boolean	Başlığı gösterir/gizler.
header	title	string, en fazla 255
header	description	string
footer	description	string
footer	previousText, nextText, submitText, resetButtonText	string	Düğme etiketleri.
footer	resetButton, submitFullWidth	boolean
footer	submitAlignment	string	left, center veya right.
general	customerTaxExempt	boolean
general	customerProcess	string	review-approving (manuel onay) veya approving (otomatik).
general	customerTags	array	Onaylanan müşterilere uygulanan etiketler.
errorMessage	required, invalidName, invalidEmail, invalidURL, invalidPhone, invalidNumber, invalidPassword, confirmPasswordNotMatch, customerAlreadyExists, fileSizeLimit, fileNotAllowed, requiredCaptcha, shopifyInvalidPhone, shopifyPhoneHasAlready, shopifyInvalidProvice, otherError	string	Her doğrulama hatası için özel metin.
reCaptcha	enable	boolean
afterSubmit	action	string	clearForm, redirectToPage veya hideForm.
afterSubmit	message, redirectUrl	string

Yanıt

200 – Success, oluşturulan kaydı döndürür. Yanıt yapısı için aşağıdaki Registration Form alma bölümündeki örneğe bakın.

Registration Form güncelleme

PUT https://wholesale.samita.io/api/v1/registration-forms/{id}

Create ile aynı üstbilgiler. Yalnızca değiştirmek istediğiniz alanları gönderin; title, status ve secret_configs (GET tarafından döndürülenle aynı yapıda, configs anahtarı altındaki tam yapılandırma nesnesi) isteğe bağlıdır. Belirtilmeyen alanlar mevcut değerini korur. Bu API, Update izni gerektirir.

Registration Form alma

GET https://wholesale.samita.io/api/v1/registration-forms/{id}

Create ile aynı üstbilgiler, istek gövdesi yok. Bu API, View izni gerektirir.

200 – Success örneği:

{
  "id": 1,
  "title": "Wholesale Registration",
  "status": true,
  "created_at": "2026-01-15T10:00:00",
  "updated_at": "2026-01-15T10:00:00",
  "configs": {
    "header": {
      "active": true,
      "title": "Apply for a wholesale account",
      "description": ""
    },
    "footer": {
      "previousText": "Back",
      "nextText": "Next",
      "submitText": "Submit",
      "resetButton": false,
      "resetButtonText": "Reset",
      "submitFullWidth": false,
      "submitAlignment": "left"
    },
    "general": {
      "customerTaxExempt": false,
      "customerProcess": "review-approving",
      "customerTags": ["wholesale"]
    },
    "reCaptcha": {
      "enable": false
    },
    "afterSubmit": {
      "action": "clearForm",
      "message": "Thanks! We'll review your application shortly.",
      "redirectUrl": ""
    },
    "integration": {
      "shopify": {
        "ifExist": "returnError",
        "showMessage": true,
        "sendEmailInvite": true,
        "acceptsMarketing": false,
        "integrationElements": {
          "email": "email",
          "first_name": "first_name",
          "last_name": "last_name"
        }
      }
    },
    "elements": [
      { "id": "first_name", "type": "name", "label": "First name", "required": true, "columnWidth": 50 },
      { "id": "last_name", "type": "name", "label": "Last name", "required": true, "columnWidth": 50 },
      { "id": "email", "type": "email", "label": "Email", "required": true, "columnWidth": 100 }
    ]
  }
}

Registration Form silme

DELETE https://wholesale.samita.io/api/v1/registration-forms/{id}

Create ile aynı üstbilgiler. Silinecek form kimliklerinin virgülle ayrılmış listesi olan bir ids parametresi iletin (sorgu dizesi parametresi veya JSON gövde alanı olarak), örneğin ids=1,2,3. Bu API, Delete izni gerektirir.

200 – Success:

{
  "success": true
}

Hata yanıtları

4 uç noktanın tamamı, Public API’nin geri kalanıyla aynı hata yanıtlarını paylaşır; 401 Unauthorized, 403 Forbidden ve 429 Too Many Requests için Genel API’ler sayfasına bakın.