​

Tercih Merkezi: herkese açık opt-in/opt-out sayfası

İngilizce asıl: Preference center: the public opt-in/opt-out page.

​

1. Bir kez yapılandırın: POST/GET /preference-center

​

Yapılandırma alanları

​

Abonelik konuları

• name (1–120 karakter) — sayfada görüntülenen ad.
• description (isteğe bağlı, ≤500) — düğmenin yanında gösterilen bir satır bağlam.
• defaultOptIn (varsayılan false) — kaydedilmiş tercih olmayan bir kişinin nasıl değerlendirildiği.
• archived (isteğe bağlı) — arşivlenmiş konular denetim izinde kalır ama artık sayfada görüntülenmez.

​

2. Kişi başına bağlantı oluşturun

curl -X POST "https://api.orbit.devotel.io/api/v1/compliance/preference-center/link" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contactId": "cnt_01H…" }'

• Bağlantı barındırılmış sayfaya, JSON uç noktasına değil. Bunu alt bilgi/gönderici şablonlarınıza harfiyen kopyalayın; sayfa kendisi veri uç noktasını arka planda çağırır.
• 30 günlük TTL. Sonrasında token süresi dolmuş olarak doğrulanır ve kişi yeni bir bağlantı istemek zorunda kalır (yenisini oluşturmak bir API çağrısı alır).
• Sayfa oluşturma zamanında yerel ayar bilmez. Web uygulaması ?token= sorgusunu korurken bir yönlendirmeyi çözer, böylece kişinin yerel ayarını tahmin etmeniz gerekmez.

​

Nereye konulacağı

• E-posta altbilgisi (birincil). Oluşturulan bağlantıyı (veya postacınızın kullandığı kısa izlenen varyantı) pazarlama şablonlarının abonelikten çıkma alanına ekleyin.
• SMS / WhatsApp yedeği. Mesajda altbilgi bloğu yoksa, bağlantıyı satır içi ekleyin: {optOutMessage}: {link}. Giden gövdeleri oluşturan yardımcı, önceden oluşturulmuş bir kısa bağlantıyı kabul eder, böylece abonelikten çıkma tıklamanız normal tıklama atıbarını almaya devam eder.
• Bastırma-taraflı yeniden-opt-in. Bir kişi başka bir akıştan yeniden-opt-in olduğunda, ona yeni bir bağlantı verebilirsiniz, böylece aynı self-servis sayfayı alır.

​

3. Herkese açık token sayfası

• GET /preferences/:token — sayfa yükünü döndürür.
• PUT /preferences/:token — güncellemeler uygular.

​

GET yanıtı

{
  "contactId": "cnt_01H…",
  "displayName": "…",
  "email": "m*****@example.com",
  "phone": "+15551****…",
  "channelPreferences": { "sms": "opted_in", "email": "opted_out" },
  "frequencyPreference": "all",
  "channels": ["sms", "email"],
  "topics": [ { "id": "newsletter", "name": "Newsletter", "defaultOptIn": false } ],
  "topicPreferences": { "newsletter": "opted_in" },
  "consentHistory": [
    { "channel": "all", "state": "opted_out", "topicId": "newsletter", "occurredAt": "2026-09-01T…" }
  ],
  "config": { /* organizasyonun tercih merkezi yapılandırması */ }
}

​

PUT isteği gövdesi

{
  "channelPreferences": {
    "sms": "opted_in",
    "email": "opted_out"
  },
  "frequencyPreference": "important_only",
  "topicPreferences": { "newsletter": "opted_in" },
  "requestDataDeletion": false
}

• channelPreferences — kısmi haritaya izin verilir (Zod kısmi-kayıt); en az bir kanal gerekli.
• frequencyPreference — isteğe bağlı, all, important_only, weekly_digest, monthly_digest biri.
• topicPreferences — yapılandırılan konularınıza karşı doğrulanan { topicId: opted_in | opted_out } haritası; bilinmeyen id’ler yoksayılır.
• requestDataDeletion — opt-out yanında bir GDPR-silme isteği ayarlar (bölüm 6’yı görün).

​

4. Güncellemeler nasıl akar

• Onay defteri. Kanal (veya konu) başına bir consent_records satırı source: preference_center ile eklenir — GDPR Madde 7 ispat yükü denetim izininiz.
• Bastırma listesi. Herhangi bir opt-out edilen kanalda, kişinin kanonikleştirilmiş telefon/e-postası all kapsamıyla eklenir — her send kapısının okuduğu kanallar arası blok.
• STOP koruması. Opt-out üzerinde bir Redis hızlı-yol koruması ayarlanır (ve tam yeniden-opt-in üzerinde temizlenir), böylece havada olan kampanya yığınları daha yavaş veritabanı bastırma yayılımından önce değişikliği görür.
• Denetim günlüğü. Yapılandırmayı değiştirdiğinizde compliance.preference_center_updated kaydedilir ve kişi düzeyi opt-in/out olayları onay defterine yakalanır.

​

5. GDPR-silme düğmesi anlambilimi

​

6. Test etmek

curl -X POST "https://api.orbit.devotel.io/api/v1/compliance/preference-center" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Acme Logistics",
    "primaryColor": "#1d4ed8",
    "channels": ["sms", "email"],
    "headerText": "Manage how Acme contacts you",
    "topics": [
      { "id": "shipping-updates", "name": "Shipping updates", "defaultOptIn": true },
      { "id": "promotions", "name": "Promotions", "defaultOptIn": false }
    ]
  }'

LINK=$(curl -s -X POST "https://api.orbit.devotel.io/api/v1/compliance/preference-center/link" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contactId":"cnt_01H…"}' | jq -r '.link')

TOKEN="${LINK#*token=}"

curl -s "https://api.orbit.devotel.io/api/v1/compliance/preferences/$TOKEN" | jq

curl -s -X PUT "https://api.orbit.devotel.io/api/v1/compliance/preferences/$TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"channelPreferences":{"sms":"opted_out"}}' | jq

​

İlgili

• Gönderi kapıları ve gönderi öncesi koruyucular — tercih merkezi özetinin sessiz saatler, acil durum durakları ve sınırlarla birlikte yaşadığı yer.
• Opt-Out & Bastırma Listeleri — all kapsamının ve toplu CSV içe aktarmalarının bu yüzeyle nasıl ilişkili olduğu.
• Onay yönetimi — aynı onay defterini saklayan operatör tarafı API.
• DSAR referansı — requestDataDeletion isteklerini yönlendirmek için takip edilen silme hattı.