API ve Webhook'lar

Salonnare API'si ve webhook'ları ne işe yarar, bunları ne için kullanırsın ve API anahtarları ile webhook'lar nasıl oluşturulur.

API ve Webhook'lar

Salonnare API'si ve webhook'ları ile salonunu diğer yazılımlara bağlarsın: muhasebe paketin, kendi web siten, bir bülten hizmeti veya kendi yaptığın bir panel. Bunların ne yaptığını anlamak için geliştirici olman gerekmez - bu sayfa sakin bir şekilde açıklıyor.

Henüz mevcut değil

Bu özellik uygulamada hâlâ Yakında olarak işaretlidir: şu anda API anahtarları veya webhook'lar oluşturamazsın. Ayarlar > API ve Webhook'lar'ı açarsan, sadece özelliğin yolda olduğuna dair bir bildirim görürsün. Bu sayfa, özellik mevcut olduğunda nasıl çalışacağını açıklar.

API nedir?

Bir API (Uygulama Programlama Arayüzü), iki programın birbiriyle konuşmasına izin veren bir anlaşmadır. Bir randevuyu yüklemek için uygulamada bir düğmeye tıkladığın yerde, başka bir program aynı veriyi API üzerinden talep edebilir - otomatik olarak ve manuel adımlar olmadan.

Bir salon için pratik örnekler:

  • Muhasebe yazılımın her gece cironu otomatik olarak çeker.
  • Kendi web siten, hizmetlerini ve fiyatlarını doğrudan Salonnare'den gösterir.
  • Bir entegrasyon ortağı müşteri listeni senkronize eder.

API'ye erişim bir API anahtarı ile çalışır: isteğin senden geldiğini kanıtlayan gizli bir kod. Bu anahtara bir şifre gibi davran.

Bir API anahtarı oluşturma

  1. Ayarlar -> API ve Webhook'lar'a git.
  2. API anahtarları sekmesinde Yeni anahtar'a tıkla.
  3. Anahtara tanınabilir bir ad ver (örneğin "Muhasebe") ve yetkileri seç: Sadece okuma, Okuma + yazma veya Tam erişim. Şu anda, hangi yetki düzeyini seçersen seç, bir API anahtarı sadece veri çekebilir; zaten sadece okuma yetkili bir anahtar bundan fazlasını hiçbir zaman yapamaz.
  4. Anahtarı hemen kopyala ve güvenli bir şekilde sakla. Güvenlik nedeniyle Salonnare, tam anahtarı sadece bir kez gösterir.

Bir anahtarın sızdığından şüpheleniyor musun? Hemen sil - o anahtarı kullanan her entegrasyon hemen durur.

Webhook nedir?

Bir webhook, API'nin tersidir. Sen veri çekmek yerine, bir şey olduğu anda Salonnare otomatik olarak sana ait bir adrese (URL) bir mesaj gönderir. Diğer yazılımın artık sürekli "yeni bir şey var mı?" diye sormasına gerek kalmaz - sinyali kendiliğinden alır.

Salonnare şu altı olayı gönderebilir:

  • booking.created - bir personel uygulamada bir randevu oluşturur
  • booking.updated - bir personel uygulamada bir randevuyu değiştirir (tamamlandı veya gelmedi durumuna değişiklik dahil)
  • booking.cancelled - bir personel uygulamada bir randevuyu iptal eder
  • payment.received - bir personel kasada bir ödeme tamamlar
  • client.created - bir personel uygulamada bir müşteri oluşturur
  • client.updated - bir personel uygulamada müşteri bilgilerini değiştirir
Sadece uygulamada olanlar

Her olay bir personelin uygulamadaki bir eyleminden gelir. Randevu sayfan veya Google üzerinden alınan online bir randevu, bir müşterinin kendisi iptal etmesi, bir bekleme listesi dönüşümü, tekrarlayan bir seri, bir kür ve bir müşterinin randevu sayfasında kendi kaydını oluşturması (henüz) bir bildirim göndermez. Bunu entegrasyon ortağına belirt: kaçırılan randevuları periyodik olarak randevu listesini çekerek yakalayabilirler.

Bir webhook kurma

  1. Ayarlar -> API ve Webhook'lar'a git ve Webhook'lar sekmesini aç.
  2. Yeni webhook'a tıkla.
  3. Salonnare'in bildirimleri göndermesi gereken URL'yi gir (bunu entegrasyon ortağın veya geliştiricin sağlar).
  4. Tepki vermek istediğin olayları seç.
  5. Kaydet. Ardından bildirimlerin doğru şekilde ulaşıp ulaşmadığını görmek için teslimat günlüklerini inceleyebilirsin.

Salonnare'in mesajları imzalamak için kullandığı gizli anahtar, webhook'u kaydettiğin anda gösterilir - bunu da bir API anahtarı gibi hemen güvenli bir şekilde sakla, çünkü Salonnare onu bir daha göstermeyecek. Kaybedersen, webhook'un yanındaki yenileme simgesine tıkla (Yeni bir gizli anahtar iste); ardından yeni bir gizli anahtarı bir kez göreceksin. Eski gizli anahtar o andan itibaren çalışmayı durdurur, bu nedenle alıcı tarafın da güncellenmesi gerekir.

Her webhook bildirimi, alıcının mesajın gerçekten Salonnare'den geldiğini doğrulamak için kullanabileceği bir imza taşır.

Güvenli çalışma

  • API anahtarlarını asla herkese açık paylaşma (e-postada, ekran görüntülerinde veya çevrim içi paylaşılan kodda değil).
  • Bir entegrasyona sadece gerçekten gerekli yetkileri ver - mümkün olduğunda sadece okuma seç.
  • Artık kullanmadığın anahtarları ve webhook'ları sil.

Salonnare verilerini AB'de işlediği ve hangi entegrasyonların erişim alacağına sen karar verdiğin için, verilerin üzerinde tam kontrolü elinde tutarsın. Bir entegrasyonla ilgili yardıma mı ihtiyacın var? Destek sayfası üzerinden bizimle iletişime geçmekten çekinme.

Geliştirici misin ve teknik detayları (kimlik doğrulama, uç noktalar, alanlar, hata kodları, imza doğrulama) mı arıyorsun? Bkz. API Reference - bu sayfa geliştiricilere yönelik olduğu için İngilizcedir.

İlgili makaleler