retrieve-checkout-design
POST /api/{team}/gateway/retrieve-checkout-design
Ödeme sayfasının (sipariş, ödeme linki ve abonelik ödemelerinin alındığı sayfa) güncel tasarımını döner; hiçbir şeyi değiştirmez. Tasarım hiç kaydedilmemişse varsayılan değerler döner.
Yalnızca iş ortağının açtığı çalışma alanlarında çalışır; diğerleri 403 alır. Bkz. İş Ortakları.
Kimlik doğrulama
Çalışma alanının anahtarıyla: X-Api-Key, X-Timestamp, X-Signature, Content-Type: application/json. Ayrıntılar: Kimlik Doğrulama ve İmza.
İstek
Gövde boş bir nesnedir:
{}
SDK örnekleri
not
Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.
- PHP
- Node.js
- Python
- Java
- cURL
$design = $client->retrieveCheckoutDesign()->checkoutDesign;
$design->logo; // yoksa null
$design->accentColor;
$design->requiresTerms;
$design->termsUrl; // yoksa null
const { checkoutDesign } = await client.retrieveCheckoutDesign();
checkoutDesign.logo; // yoksa null
checkoutDesign.accentColor;
checkoutDesign.requiresTerms;
checkoutDesign.termsUrl; // yoksa null
design = client.retrieve_checkout_design().checkout_design
design.logo # yoksa None
design.accent_color
design.requires_terms
design.terms_url # yoksa None
import com.odemehub.request.RetrieveCheckoutDesign;
var design = client.retrieveCheckoutDesign(new RetrieveCheckoutDesign()).getCheckoutDesign();
design.getLogo(); // yoksa null
design.getAccentColor();
design.requiresTerms();
design.getTermsUrl(); // yoksa null
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/retrieve-checkout-design"
BODY='{}'
TIMESTAMP=$(date +%s)
SIGNATURE=$(printf '%s\n%s\n%s\n%s' "$TIMESTAMP" "POST" "$URI_PATH" "$BODY" | openssl dgst -sha256 -hmac "$ODEMEHUB_API_SECRET" | sed 's/^.* //')
curl -X POST "https://sandbox.odemehub.com$URI_PATH" \
-H "Content-Type: application/json" \
-H "X-Api-Key: $ODEMEHUB_API_KEY" \
-H "X-Timestamp: $TIMESTAMP" \
-H "X-Signature: $SIGNATURE" \
--data-raw "$BODY"
Yanıt
{
"result": { "successful": true, "message": null },
"checkout_design": {
"logo": "https://app.odemehub.com/storage/12/logos/Yw3k...png",
"layout": "standard",
"is_reversed": false,
"summary_color": "#1f2937",
"accent_color": "#2563eb",
"font": "inter",
"form_style": "rounded",
"takes_coupons": false,
"offers_shipping_methods": false,
"submit_type": "auto",
"payment_method_style": "list",
"requires_terms": true,
"terms_url": "https://magazam.com/hizmet-sartlari",
"takes_company": true
}
}
Ödeme sayfası tasarımı nesnesi
| Alan | Tip | Açıklama |
|---|---|---|
logo | string | null | Logonun adresi; create-logo ile yüklenir. Logo yoksa null. |
layout | string | Yerleşim: standard ya da card. |
is_reversed | boolean | Paneldeki Ters çevir seçeneği; açıksa true. |
summary_color | string | Marka rengi, #rrggbb. |
accent_color | string | Vurgu rengi, #rrggbb. |
font | string | Yazı tipi: default, be_vietnam_pro, bitter, chakra_petch, hahmlet, inconsolata, inter, lato, lora, m_plus_1_code, montserrat, noto_sans, noto_sans_jp, noto_serif, nunito, open_sans, pridi, pt_sans, pt_serif, raleway, roboto, roboto_slab, source_sans_3, titillium_web, ubuntu_mono, zen_maru_gothic. |
form_style | string | Köşeler: rounded, rectangular ya da pill. |
takes_coupons | boolean | Kupon kodu alanı gösterilirse true. |
offers_shipping_methods | boolean | Gönderim seçenekleri gösterilirse true. |
submit_type | string | Ödeme butonunun metni: auto (abonelikte "Abone Ol", diğerlerinde "Öde"), pay, book, donate, subscribe. |
payment_method_style | string | Ödeme yöntemlerinin gösterimi: list ya da tabs. |
requires_terms | boolean | Ödeyenin hizmet şartlarını kabul etmesi gerekiyorsa true. |
terms_url | string | null | Hizmet şartlarının adresi. |
takes_company | boolean | Kurumsal fatura bilgisi alınırsa true. |
HTTP durum kodları
| Kod | Durum |
|---|---|
200 | Tasarım döndü. |
401 | API anahtarı ya da imza geçersiz. |
403 | Çalışma alanı işlem yapamıyor ya da bir iş ortağının açtığı çalışma alanı değil: Bu uç yalnızca iş ortağı çalışma alanlarına açıktır. |
429 | İstek sınırı aşıldı. |