API anahtarları

Güncellendi:

Nerede: Ayarlar > Entegrasyonlar > API anahtarları

Ne işe yarar:

"Harici bir programa SyBox üzerinden göndermesi için kendi anahtarını verin — WhatsApp belirteci asla sunucudan ayrılmaz ve sızdırılan bir anahtar kendi başına iptal edilir." ERP'niz, satış noktanız veya masaüstü programınız bir SyBox anahtarı kullanır. Gerçek WhatsApp giriş bilgilerinize hiçbir zaman ihtiyaç duymaz.

Bir programın anahtarla yapabilecekleri (herkese açık Geliştirici Belgeleri sayfasında açıklanmıştır):

  • Bağlı kendi numaranızdan WhatsApp mesajları gönderebilir. Meta'nın WhatsApp Cloud API'si ile aynı istek formatını kullanır; bu nedenle bunun için önceden yazılmış bir programın yalnızca yeni bir adrese ve bir SyBox anahtarına ihtiyacı vardır. Metin, şablonlar, görseller, belgeler ve etkileşimli mesajların tümü çalışır. Yanıtlar ve hatalar Meta'nın verdiği şekilde geri döner.
  • Kendi sisteminizden, örneğin ERP'nize kaydedilen bir şikayet için kayıt açabilir. Müşterinin SyBox'ta zaten mevcut olması gerekir.
  • Bir telefondaki SMS'leri gelen kutusuna aktarabilir.
  • Başka bir sistemden otomasyonlarınızı başlatabilir ("Otomasyon başlat" türünde bir anahtar).
  • Başka bir sistemden kişilerinizi bulabilir, okuyabilir ve değiştirebilir ("Kişileri oku ve güncelle" türünde bir anahtar).

Kimler açabilir: Ana yönetici ve "Kanalları yönetin" iznine sahip ekip üyeleri.

"API ağ geçidi" anahtarı:

API anahtarları ekranının üst kısmında "API ağ geçidi" adında bir anahtar bulunur. Varsayılan olarak kapalıdır. Kapalı olduğu sürece hiçbir anahtar çalışmaz ve yeni anahtarlar oluşturamazsınız. Denerseniz "API ağ geçidi kapalı. Anahtar oluşturmadan önce bu ekranın üst kısmındaki anahtardan açın." uyarısını görürsünüz. Anahtara tıkladığınız anda ayar kaydedilir.

Ağ geçidi nasıl açılır ve anahtar nasıl oluşturulur

  1. Ayarlar > Entegrasyonlar > API anahtarları bölümüne gidin.
  2. "API ağ geçidi" anahtarını açın.
  3. "Yeni anahtar"a tıklayın.
    Settings, API keys: keys that let another program send through SyBox, and the "New key" button
  4. "Anahtar türü"nü seçin:
    • "WhatsApp üzerinden gönder": Program müşterilerinize mesaj gönderir.
    • "Şikayet kaydı aç": Program SyBox'ta kayıt açar. Mesaj gönderemez.
    • "Telefondan SMS içe aktar": Bir telefon SMS mesajlarını gelen kutusuna iletir.
    • "Otomasyon başlat": Program, "Şu durumda başlar" ayarı "Başka bir program SyBox'ı çağırdığında" olan otomasyonları başlatır (müşterinin "phone" bilgisi ve isteğe bağlı "event" ile "data" parametreleriyle POST /v1/automation). Mesaj gönderemez. Ayarlar > Yapay zeka ve otomasyon > Otomasyonlar bölümüne bakın.
    • "Kişileri oku ve güncelle": Program kişileri bulur, bir kişiyi okur ve adını, e-postasını, kişi alanlarını ve etiketlerini değiştirir (POST /v1/contacts/search, /get, /update ve /labels). Mesaj gönderemez. Anahtar, onu oluşturan kişi adına hareket eder: yalnızca o kişinin görebileceği kişileri görür, yalnızca o kişi kişiler listesini açıp numaraları görebiliyorsa çalışır ve kişileri yalnızca o kişi düzenleyebiliyorsa değiştirebilir. O kişi devre dışı bırakılırsa anahtar çalışmayı durdurur.
  5. "Cihaz veya program adı" alanını doldurun, örneğin "Ofis bilgisayarı" veya "Muhasebe sistemi". Her cihaza veya programa kendi anahtarını verin.
  6. "WhatsApp üzerinden gönder" anahtarı için şunları da ayarlayın:
    • "Şuradan gönderir": Bu anahtarın gönderim yapacağı WhatsApp numarası (zorunlu).
    • "Serbest metin mesajlarına izin ver": Açık veya kapalı.
    • "Onaylı şablonlara izin ver": Açık veya kapalı. Bu ikisinden en az biri açık olmalıdır, aksi takdirde "Serbest metin veya şablonlardan en az birine izin verin — aksi halde anahtar hiçbir şey gönderemez." uyarısını görürsünüz.
    • "Medya göndermeye izin ver": Açık veya kapalı.
    • "Şablonlar" (isteğe bağlı): Virgülle ayrılmış şablon adları. Tüm şablonlara izin vermek için boş bırakın.
    • "İzin verilen alıcı ülkeleri" (isteğe bağlı): İki harfli ülke kodları, örneğin TR,FR,DE. Tüm ülkelere izin vermek için boş bırakın.
    • "Gönderim şu saatten" ... "olarak gösterilir": Anahtarın gönderim yapabileceği saatler. Zaman sınırı olmaması için her ikisini de aynı bırakın. Saatler, çalışma alanının yerel saatine göredir.
    • "Günlük mesaj sınırı (0 = sınırsız)".
  7. "Telefondan SMS içe aktar" anahtarı için "Yalnızca kişiler ve müşteriler" ayarını yapın. Açık olduğunda, diğer numaralardan gelen SMS'ler telefonda kalır ve asla gelen kutusuna ulaşmaz. Bunu yalnızca telefon sadece iş için kullanılıyorsa kapatın.
  8. Kaydet'e tıklayın.
  9. Açılan pencerede "Temel URL" ve "API anahtarı" gösterilir. Bunları hemen kopyalayın. "Bu anahtarı şimdi kopyalayın — yalnızca bir kez gösterilir." Programınızın ayarlarına ekleyin.

Anahtar kartında neler görünür:

  • Anahtarın adı ve gönderim yaptığı numara (veya gönderim yapmayan bir anahtar için tür rozeti).
  • Anahtarları birbirinden ayırt edebilmeniz için anahtarın son karakterleri.
  • Tarih ve saat içeren "son kullanılan" bilgisi veya "hiç".
  • Açık olan tüm sınırlamalar: "Yalnızca serbest metin", "Yalnızca şablonlar", "medya yok", "Şablonlar", izin verilen ülkeler, gönderim saatleri ve bugün gönderilen / sınır / gün şeklinde gösterilen günlük limit. Tüm numaraları kabul eden bir SMS anahtarı "Tüm numaralar" olarak görünür.

Bir anahtar nasıl değiştirilir, duraklatılır veya silinir

  1. Anahtar kartında Düzenle'ye tıklayın. Adını, numarasını ve limitlerini değiştirebilirsiniz. Anahtar türü oluşturulduktan sonra değiştirilemez ve anahtarın kendisi bir daha asla gösterilmez.
    To change, pause or delete a key: "Edit" marked on the screen in SyBox
  2. Bir anahtarı geçici olarak durdurmak için Etkinleştir / Devre Dışı Bırak'a tıklayın.
  3. Sil'e tıklayın, ardından onaylayın: "Bu API anahtarı silinsin mi? Hâlâ kullanan her program hemen çalışmayı durdurur."
API anahtarımı kaybettim. Tekrar görebilir miyim?

Hayır. Yalnızca bir kez gösterilir. Yeni bir anahtar oluşturun, programınıza ekleyin ve ardından eski anahtarı silin.

Bir anahtarın sızdırıldığını düşünüyorum. Ne yapmalıyım?

O anahtarı hemen silin veya devre dışı bırakın. Yalnızca o anahtarın çalışması durur. WhatsApp numaranız ve diğer anahtarlarınız etkilenmez.

"Şuradan gönderir" listesi boş.

Liste yalnızca bağlı ve açık olan WhatsApp numaralarını gösterir. Önce Ayarlar > Mesajlaşma > Kanallar altından bir numara bağlayın.

Programım gönderim yaparken reddediliyor.

"API ağ geçidi" anahtarının açık ve anahtarın aktif olduğunu kontrol edin. Ayrıca anahtarın sınırlarını kontrol edin: serbest metin ve şablonlar, medya, izin verilen şablonlar, izin verilen ülkeler, gönderim saatleri ve günlük limit. WhatsApp'ın kendi kuralları da geçerliliğini korur. Örneğin serbest metin, yalnızca müşterinin son mesajından sonraki 24 saat içinde çalışır.

"Şikayet kaydı aç" türündeki bir anahtar mesaj da gönderebilir mi?

Hayır, bu bilinçli bir tercihtir. Kayıt açan bir anahtar müşterilere mesaj gönderemez ve gönderim yapan bir anahtar kayıt açamaz. Her iş için ayrı bir anahtar kullanın.

"Bir programdan al" türünde eski bir anahtarım var. Hâlâ çalışıyor mu?

Evet, bu türdeki mevcut anahtarlar çalışmaya devam eder. Artık bu türde yeni anahtarlar oluşturulamaz. Bu tür işlemler için bunun yerine "Şikayet kaydı aç" özelliğini kullanın.