update-checkout-design
POST /api/{team}/gateway/update-checkout-design
Ödeme sayfasının tasarımını değiştirir; yalnızca gönderilen alanlar değişir. Değişiklik, sayfanın bir sonraki açılışından itibaren görünür. Logo önce create-logo ile yüklenir, dönen adres burada logo olarak gönderilir.
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
{
"checkout_design": {
"logo": "https://app.odemehub.com/storage/12/logos/Yw3k...png",
"accent_color": "#2563eb",
"font": "inter",
"requires_terms": true,
"terms_url": "https://magazam.com/hizmet-sartlari"
}
}
checkout_design zorunludur ve yalnızca tasarım nesnesindeki alanları taşır; başka anahtar gönderilirse 422. Alanların değerleri o tablodaki gibidir. Ek kurallar:
| Alan | Kural |
|---|---|
logo | create-logo ile alınan adres, en çok 255 karakter. Logoyu kaldırmak için null. |
terms_url | http ya da https ile başlayan adres, en çok 255 karakter; null gönderilebilir. |
summary_color, accent_color | # ve altı onaltılık hane, örneğin #2563eb. |
| Diğer alanlar | Gönderilirse null olamaz. |
requires_terms açıkken hizmet şartları adresi bulunmalıdır: istekte gönderilmiş ya da daha önce kaydedilmiş olmalıdır.
SDK örnekleri
Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak. SDK'larda logoyu ya da terms_url'i kaldırmak için PHP ve Python'da clear, Node.js ve Java'da alana null verilir.
- PHP
- Node.js
- Python
- Java
- cURL
use Gurmehub\Odemehub\Request\UpdateCheckoutDesign;
$design = $client->updateCheckoutDesign(new UpdateCheckoutDesign(
accentColor: '#2563eb',
font: 'inter',
))->checkoutDesign;
$client->updateCheckoutDesign(new UpdateCheckoutDesign(clear: ['logo'])); // logoyu kaldırır
const { checkoutDesign } = await client.updateCheckoutDesign({
accentColor: '#2563eb',
font: 'inter',
});
await client.updateCheckoutDesign({ logo: null }); // logoyu kaldırır
from odemehub.request import UpdateCheckoutDesign
design = client.update_checkout_design(UpdateCheckoutDesign(
accent_color="#2563eb",
font="inter",
)).checkout_design
client.update_checkout_design(UpdateCheckoutDesign(clear=["logo"])) # logoyu kaldırır
import com.odemehub.request.UpdateCheckoutDesign;
var design = client.updateCheckoutDesign(UpdateCheckoutDesign.builder()
.accentColor("#2563eb")
.font("inter")
.build()).getCheckoutDesign();
client.updateCheckoutDesign(UpdateCheckoutDesign.builder().logo(null).build()); // logoyu kaldırır
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/update-checkout-design"
BODY='{"checkout_design":{"accent_color":"#2563eb","font":"inter"}}'
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 ve tasarımın güncel hâli (checkout_design): Ödeme sayfası tasarımı nesnesi.
HTTP durum kodları
| Kod | Durum |
|---|---|
200 | Tasarım güncellendi. |
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. |
422 | Doğrulama hatası. |
429 | İstek sınırı aşıldı. |
Hatalar
| Alan | Mesaj |
|---|---|
checkout_design.terms_url | Hizmet şartları açıkken hizmet şartları adresi zorunludur. |