API erişimi (geliştiriciler için)

Ayarlar → Entegrasyonlar (/app/settings/integrations), sayfanın altındaki API erişimi (geliştiriciler için) kartı. Yalnızca sahipler ve yöneticiler. "Gönderileri otomatik oluşturmak, kişi eklemek veya analizleri okumak için OmniBrand'i kendi sistemlerinize, Zapier'e veya Make'e bağlayın." Bir anahtar, kendi yazılımınızın OmniBrand genel API'sini Authorization: Bearer ob_live_… başlığıyla çağırmasını sağlar. Kartın altındaki API uç noktası, bu isteklerin gönderileceği adresi gösterir ("Halka açık API'nin yanıt verdiği adres. Her isteği yukarıdaki anahtarlardan biriyle oraya gönderin."). /app/settings#developer adresine giden eski bağlantılar bu kartı açar.

Hangi planlarda var

API erişimi Agency ve Enterprise planlarının bir parçasıdır. Ücretsiz, Starter ve Pro planlarında ve 14 günlük Pro denemesi sırasında kart yalnızca "API erişimi Agency planında sunulur." yazar ve Plan ve kullanım sayfasına giden Planları gör bağlantısını gösterir; anahtar formu yoktur. Plan ve kullanım sayfasındaki ve /pricing sayfasındaki plan kartları Agency ve Enterprise için API erişimi gösterir.

Plan değiştiğinde

• Hesap API erişimi olmayan bir plana geçtiğinde (plan düşürme, iade veya bir denemenin bitmesi), anahtarları duraklatılır: saklanmaya devam eder ve hiçbir şey silinmez, ancak bunlarla yapılan her çağrı "API access is available on the Agency and Enterprise plans. Upgrade under Settings > Plan & usage to use API keys." mesajıyla reddedilir (HTTP 403, kod api_access_not_in_plan).
• Hesap sahibine Planları gör düğmesiyle tek bir e-posta gelir: Your API keys are paused ("Planınız artık API erişimi içermediği için API anahtarlarınız duraklatıldı…").
• Agency veya Enterprise planına geri dönmek aynı anahtarları bir dakika içinde yeniden etkinleştirir. Yeni anahtar oluşturmanız gerekmez.
• Duraklatıldığı sürece anahtarlar listelenmez, oluşturulamaz ve yenilenemez. Bir anahtarı kalıcı olarak durdurmak için API erişimi olan bir plana geçip anahtarda İptal et'e tıklayın veya destekle iletişime geçin.

Adım adım: bir anahtar oluştur

1. Anahtar adı (örneğin CI bot) bir isim yazın, en fazla 60 karakter için, böylece daha sonra neyin kullandığını öğrenirsiniz. İsim olmadan (veya sadece boşluklar) Anahtar oluştur hiçbir şey yaratmaz ve kutu "Anahtara isim verin, örneğin "Web sitesi senkronizasyonu"." diyor. İsimden önceki ve sonrası boşluklar kaldırılır.
2. Anahtar kapsamları içinde, yalnızca okuma (veri okuma) veya okuma + yazma (aynı zamanda bir şeyler oluşturup değiştirme) seçin.
3. Anahtar oluştur'a tıklayın.
4. Sarı bir kutu ""(isim)" için yeni anahtar. Şimdi kopyala: sadece bir kez gösteriliyor." yazıyor ve tam anahtar, Kopyala (ardından Kopyalandı diyor) ve Kaydettim ile kutuyu kapatıyor. Anahtarı şimdi kopyalayın ve güvenli bir yerde saklayın; OmniBrand sadece parmak izi saklıyor ve bir daha asla gösteremiyor.

Liste

Her tuş adı, ilk karakterler (ob_live_...), kapsamı, en son ne zaman kullanıldığı ("kullanıldı ..." veya "hiç kullanılmamış") ve "süresi dolur ..." bitiş tarihiyle birlikte gösterir.

• Yenile: önce sorar: ""(ad)" (önek…) yenilensin mi? Hemen yeni bir anahtar alırsınız. Mevcut anahtar 24 saat daha çalışır ve sonra durur; bu yüzden yeni anahtarı o zamana kadar eski anahtarın kullanıldığı her yere koyun." Devam etmek için Anahtarı yenile'ye ya da İptal'e tıklayın. Aynı ad ve kapsama sahip yeni anahtar aynı sarı kutuda bir kez gösterilir. Eski anahtar, entegrasyonunuzu geçirebilmeniz için 24 saat çalışmaya devam eder, sonra durur. O zamana kadar listede, üstü çizilmeden, "Eski anahtar [tarih ve saat] tarihine kadar çalışır" ve bir İptal et düğmesiyle kalır.
• İptal et: "(ad) (önek…) anahtarı iptal edilsin mi? Onu kullanan her şey hemen çalışmayı durdurur ve iptal edilen bir anahtar yeniden açılamaz." diye sorar. Pencerenin başlığı Anahtar iptal edilsin mi? olur; anahtarı hemen durdurmak için Anahtarı iptal et, tutmak için İptal düğmesine tıklayın. Bu, bir yenilemeden sonraki 24 saat içinde eski bir anahtar için de çalışır: anahtar sızdığı için yenilediyseniz, hemen durması için eski anahtarda İptal et düğmesine tıklayın. İptal edilen anahtarlar (ve 24 saatleri dolduktan sonra yenilenen anahtarlar) listede üstü çizili olarak, adın altında kırmızı bir "(tarih) tarihinde iptal edildi" etiketiyle kalır.

Anahtarın sahibi kim

• Bir anahtar, onu oluşturan kişiye aittir ve o kişinin oluşturulma anında sahibi veya yöneticisi olduğu çalışma alanlarını kapsar.
• Yalnızca yaratıcısı kapsadığı her çalışma alanının aktif sahibi veya yöneticisi olduğu sürece çalışır. Eğer kaldırılırsa, düşürülürse veya girişleri devre dışı bırakılırsa, "Bu API anahtarını oluşturan kişi artık çalışma alanlarını yönetmiyor. Mevcut bir yöneticiye yeni bir anahtar vermesini iste."
• Bakın, sadece kendi yönettiğiniz çalışma alanlarının anahtarlarını döndürüp geri alın. Birçok istemci çalışma alanı olan bir hesapta, bir müşterinin yöneticisi başka bir müşterinin anahtarlarını göremez.

Bir şeyler ters giderse

• "This API key has expired. Rotate it under Settings > Integrations > API access.": anahtarlar bir yıl geçerlidir. API erişimi (geliştiriciler için) içinde anahtarda Yenile'ye tıklayın (veya yeni bir anahtar oluşturun) ve entegrasyonunuzu güncelleyin.
• "Geçersiz veya iptal edilmiş API anahtarı": anahtar iptal edildi, 24 saatlik dönüşüm süresi sona erdi ya da eksik şekilde kopyalandı.
• Bir API anahtarı başka anahtarları oluşturamaz, döndürebilir veya geri kaldıramaz; yalnızca oturum açmış bir kişi bunu yapabilir.
• "Bu uç nokta API anahtarları için kullanılamaz": bu çağrı, anahtarın kapsamı ne olursa olsun yalnızca giriş yapmış bir kişi içindir. Bir anahtar şunlara asla erişemez: üyeler ve davetler (/workspaces/{id}/members, /workspaces/{id}/invitations, /invitations), çalışma alanı oluşturma, yeniden adlandırma, arşivleme, arşivden çıkarma veya silme, giden webhook'lar (/workspaces/{id}/webhooks), dışa aktarmalar, onay zinciri, rapor zamanlamaları, bir kanalı bağlama, bağlantısını kesme, kaldırma veya sahibini değiştirme, kuruluşun logosu, profili ve ilk kurulumu ile /auth, /billing, /admin veya /tenant/api-keys altındaki her şey. Bunları uygulamada bir sahip veya yönetici olarak giriş yapıp yapın. Anahtarla yapay zekâ; gönderi metni, fikirler, görseller, yeniden yazma, hashtag, alternatif metin ve mesaj sınıflandırmayı kapsar, anahtar başına dakikada 10 ve günde 300 çağrıya kadar ("API key AI rate limit exceeded"); video, AI Studio ve diğer yapay zekâ yardımcıları yalnızca oturum açmış kişiler içindir. Market Watch görevlerini, kaynaklarını ve ayarlarını, botları ve otomatik önceliklendirme gibi çalışma alanı ayarlarını da yalnızca oturum açmış bir kişi değiştirebilir. Desteği açıp kapatmak, yapay zeka sınıflandırmasını değiştirmek ve Brand Health yapay zeka yorumu için de oturum açmış bir kişi gerekir; anahtarla istenen bir rapor, yapay zeka özetini yalnızca özet zaten varsa içerir.

İlgili

• Planlar
• Entegrasyonlar: giden webhook'lar
• Roller ve izinler
• Ayarlar sayfası