Marka oluşturma

Social API'deki en üst düzey nesne olan bir marka oluşturur. Bir marka, kendisine bağladığınız sosyal hesapların ve bu hesaplardan yayımlanan her gönderinin sahibidir. En az bir marka oluşturulana kadar Social API'de başka hiçbir çağrı yapılamaz; bu nedenle bu, her Social entegrasyonundaki ilk istektir.

Kullanım senaryosu: bir müşteriyi sosyal platformlarda yayın yapmaya hazırlama. Bir müşteri ürününüze kaydolduğunda, adına yayın yapmak istediği her işletme için bir marka oluşturun. Döndürülen socialProfile.id değerini, ilgili işletmeye ait kendi kaydınızla ilişkilendirerek saklayın: bu değer, POST /social/brands/{brandId}/connections/link ve GET /social/brands/{brandId}/posts içindeki brandId yol belirtecidir ve oluşturduğunuz her gönderideki socialProfileId gövde alanıdır. Ardından kullanıcıyı, yayın yapmak istediği her platform için barındırılan bağlantı oluşturma bağlantısına yönlendirin.

Notlar.

• İstek gövdesi bir input nesnesi içine alınmalıdır. Social API'deki her yazma işleminde bu yapı kullanılır; tek istisna, düz bir gövde alan bağlantı oluşturma bağlantısıdır.
• HTTP durumunu değil, success değerini kontrol edin. Eksik bir profileName veya bilinmeyen bir timezone.tzCode nedeniyle oluşan doğrulama hatası, success: false ile birlikte HTTP 200 olarak döner ve hata nedeni error içinde yer alır. Çağrıyı yalnızca success değeri true olduğunda başarılı kabul edin.
• Yalnızca profileName ve timezone zorunludur. businessIntent ve categories için varsayılan değerler sırasıyla general ve boş bir listedir; dolayısıyla bu alanların karşılığı bulunmayan bir entegrasyon, bunları tamamen dışarıda bırakabilir.
• timezone.tzCode yalnızca görünüm amaçlı değildir. scheduleDate + scheduleTime ile zamanlanan bir gönderi, çağrıyı yapanın saat diliminde veya UTC'de değil, markanın saat diliminde yorumlanır. Bu değeri daha sonra değiştirmek, önceden zamanlanmış gönderilerin zamanını değiştirmez.
• Marka her zaman API anahtarının ait olduğu hesaba aittir. Başka bir hesapta marka oluşturmanın bir yolu yoktur: gövdedeki herhangi bir hesap tanımlayıcısı yok sayılır.
• Marka kimlikleri düz UUID değerleridir. Bunlar, Locations ve konum Posts için kullanılan Base64 relay kimlikleri değildir; bu nedenle bunları kodlamayın veya kodlarını çözmeyin. Aynı kimlik hem brandId yol belirteci hem de socialProfileId gövde alanı olarak görünür: brandId her zaman yalnızca bir URL belirtecidir, hiçbir zaman gövde alanı değildir.
• API planında marka sınırı yoktur. Markalar sınırsızdır ve kullanımları ölçülmez; bu nedenle bu çağrı hiçbir zaman bir üst sınır nedeniyle reddedilmez ve marka oluşturmadan önce kalan kapasiteyi kontrol etmeniz gerekmez. Kullanımı ölçülen birim bağlantılardır; her bağlantı, bir ağda bir markaya bağlanan bir sosyal hesaptır. Bağlantı kademeleri ve bağlantı paketi fiyatı için Planlar ve eklentiler sayfasına, bir kullanıcıyı bağlantı oluşturma bağlantısına yönlendirmeden önce kalan bağlantı kapasitenizi öğrenmek için GET /social/limits bölümüne bakın.

Yazma işlemi: canlı hesap üzerinde yürütülmemiştir. Gösterilen istek ve yanıt, API şemasından oluşturulmuştur.