Mevcut mesajlaşma markasının bilgilerini düzeltme
İşletmenin iletişim bilgileri veya adresi değiştiğinde mevcut markayı güncelleyin. Marka kimliğini koruyun; mevcut bir işletmenin bilgilerini düzeltmek için başka bir kayıt oluşturulmaz. Etkin bir API hesabını, HTTPS üzerinden, izin verilen bir kaynak IP adresinden kullanın. Marka bu hesaba ait olmalıdır.
Önce mevcut kaydı okuyun. İşletmenin kimlik ve iletişim bilgilerini içerdiğinden yerel kopyanızı gizli tutun.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID" \
--output current-brand.jsonMarkanın mevcut alanlarını koruma
Mevcut kayıttan yalnızca yazılabilir marka alanlarını seçerek brand-update.json dosyasını hazırlayın. Amaçlanan düzeltmeyi uygularken işletmenin kimlik bilgilerini ve diğer zorunlu değerleri koruyun. GET yanıtının tamamını göndermeyin: brandId, kimlik ve durum sonuçları, zaman damgaları ve yalnızca yanıtta bulunan diğer alanlar güncellemeye dahil edilmez.
Güncelleme şeması entityType, displayName, country, email ve brandRelationship alanlarını zorunlu tutar. İşletme türüne özgü kurallar geçerliliğini korur. Bir kuruluş için yasal şirket adını, vergi kimlik numarasını ve bu numarayı veren ülkeyi, ayrıca geçerli olduğu ölçüde adresini ve sektörünü koruyun. Şahıs işletmesi için bunların yerine ilgili kişi adı ve cep telefonu iletişim alanlarını koruyun. Kayıt örneğindeki yer tutucuları değil, gerçek ve güncel değerleri kullanın.
| Alanlar | Nasıl kullanılır |
|---|---|
| displayName, email, phone | Tanınabilir marka adı ve geçerli iletişim bilgileri. En fazla uzunluklar: 255, 100 ve 20 karakter. Telefon numaralarında + işareti ve ülke koduyla başlayan uluslararası biçimi kullanın. |
| street, city, state, postalCode, country | Birbiriyle tutarlı, gerçek işletme adresi bilgileri. Sınırlar: 255, 100, 20, 10 ve 2 karakter. Geçerli olduğu durumlarda güncel ABD eyalet kodlarını kullanın. |
| entityType, companyName, ein, einIssuingCountry | Yasal kimlik bilgileri. Kampanyalar veya harici inceleme beklemede ya da etkin olduğunda bu değişiklikler kısıtlanır. Yalnızca kimlik bilgilerine ilişkin bir kısıtlamayı aşmak için çalışan kampanyaları silmeyin. |
| firstName, lastName, mobilePhone, businessContactEmail | İşletme türüne uygun olduğu durumlarda kimlik bilgileri veya doğrulama için iletişim bilgileri. Sınırlar: 100, 100, 20 ve 255 karakter. |
| brandRelationship, vertical | Güncel ilişki ve sektör kodları. İlişki değişiklikleri üç ayda bir kez ile sınırlıdır. Portalın standart düzenleme formu ilişki değişikliği olanağı sunmaz. |
| website, altBusinessIdType, altBusinessId, stockSymbol, stockExchange | İlgili web sitesi, alternatif işletme kimliği ve halka açık şirket bilgileri. İşletmenin doğrulanması için gereken değerleri koruyun. |
| referenceId, ipAddress | Desteklenen işletme referansı ve kaynak IP üst verileri. Bunların hiçbiri markanın hangi hesaba ait olduğunu belirlemez veya isteğin idempotans anahtarı işlevini görmez. |
Kodlar için güncel mesajlaşma katalogları bilgilerini kullanın. Güncelleme şeması, markanın ortamını değiştirmek için mock alanını kullanma olanağı sunmaz. Düzenleme sırasında bu bayrağı değiştirmek yerine, test ortamından üretim ortamına geçiş için ayrı olarak incelenmiş iş akışını kullanın.
İncelenen düzeltmeyi gönderme
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
--request PUT \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @brand-update.json \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Amaçlanan bu güncelleme için tek bir anahtar kullanın ve istek gövdesinin baytlarını aynen saklayın. Anahtarın değiştirilmiş bir yöntem, yol, sorgu veya gövdeyle yeniden kullanılması çakışmaya yol açar; JSON biçimlendirmesini değiştirmek de parmak izini değiştirir. Hâlâ işlenmekte olan bir isteğin yinelenmesi, 409 yanıtını Retry-After başlığıyla birlikte döndürebilir. Tamamlanmış bir istek, hata dahil olmak üzere kaydedilmiş sonucunu yeniden döndürebilir. Zaman aşımının sonucunu netleştirirken otomatik olarak yeni bir anahtar üretmek yerine istek ayrıntılarını saklayın.
Kaydedilen kaydı ve doğrulama durumunu kontrol etme
Başarılı bir güncelleme, HTTP 200 durumunu ve doğrudan bir marka JSON nesnesini döndürür; eski v3 status/response sarmalayıcısı kullanılmaz. brandId değerini kontrol edin, ardından aynı markayı GET ile yeniden okuyup amaçlanan alanları karşılaştırın. Genel kullanıma açık güncelleme yolu, portalın changes/version sarmalayıcısını kabul etmez ve portalın iyimser eşzamanlılık kontrolünü sağlamaz. Eşzamanlı düzenleme yapanlar arasında koordinasyon sağlayın; idempotans anahtarı yinelenen gönderimi önler, başka bir düzenleyicinin değişikliklerini önlemez.
Mevcut portal markayı okur, yazılabilir alanlarını korur, kaydetmeden önce form sürümünü kontrol eder ve sonucu yeniden okur. Etkin kampanyalar bulduğunda temel yasal kimlik alanlarını kilitler. Kayıt sistemi, bir alan formda sunulmuş olsa bile harici incelemeye ilişkin kısıtlamalar dahil ek kısıtlamalar uygulayabilir.
Düzeltilmiş bilgilerin kaydedilmesi otomatik olarak yeni bir kimlik doğrulaması talep etmez veya onayı garanti etmez. Yeniden doğrulama, ücret gerektirebilen ayrı bir işlemdir; mevcut durumu portalda inceleyin ve belirtilen herhangi bir ücreti açıkça onaylayın. Normal marka PUT güncellemeleri, mevcut API hizmetinde ayrı bir kayıt ücreti tahsilatını tetiklemez. Mevcut kampanya, mesajlaşma ve diğer ücretler ayrı kalır.
Yinelenen kayıt oluşturmadan hataları giderme
HTTP durumunu ve JSON hata ayrıntılarını okuyun. 400 için ilgili alanı düzeltin veya kimlik ya da ilişki kısıtlamasına uyun. 401, 403 veya 404 için kimlik bilgilerini, izin verilen kaynak IP adresini ve markanın hesaba ait olduğunu kontrol edin. 429 için Retry-After başlığında belirtilen bekleme süresine uyun. Kayıt sistemi güncellemeyi kabul ettikten sonra da 500 veya 502 oluşabilir; varsa requestId değerini saklayın ve başka bir gönderimden önce mevcut kaydı okuyun.
Boş olmayan ancak eksik bir güncelleme yanıtı, eksik bir yerel anlık görüntü bırakabilir; gövdesi boş olan başarılı bir yanıt, anlık görüntüdeki eski alan değerlerinin korunmasına yol açabilir. Yalnızca başarı durumuna bakarak alanların korunduğu sonucuna varmayın. Markanın tüm bilgilerini yeniden okuyun ve varsa uyuşmazlıkları destek aracılığıyla giderin. Bu kılavuz, kayıt sistemi, yerel önbellek ve faturalandırma güncellemelerinin atomik olarak gerçekleşeceğini taahhüt etmez.