API i webhooki

Co to są API i webhooki Salonnare, do czego służą i jak tworzyć klucze API i webhooki.

API i webhooki

Za pomocą API i webhooków Salonnare łączysz swój salon z innym oprogramowaniem: programem księgowym, własną stroną internetową, usługą newslettera albo własnym panelem. Nie musisz być programistą, żeby zrozumieć, do czego to służy. Ta strona wyjaśnia to spokojnie i prostym językiem.

Funkcja jeszcze niedostępna

Ta funkcja w aplikacji wciąż jest oznaczona jako Wkrótce: na razie nie możesz tworzyć kluczy API ani webhooków. Jeśli otworzysz Ustawienia > API i webhooki, zobaczysz tylko informację, że funkcja jest w przygotowaniu. Ta strona opisuje, jak będzie działać, gdy funkcja się pojawi.

Co to jest API?

API (Application Programming Interface) to umowa, która pozwala dwóm programom się komunikować. Tam, gdzie Ty klikasz przycisk w aplikacji, aby wczytać wizytę, inny program może zażądać tych samych danych przez API - automatycznie i bez ręcznych kroków.

Przykłady praktyczne dla salonu:

  • Twój program księgowy automatycznie pobiera Twój przychód każdej noc.
  • Twoja własna strona internetowa pokazuje Twoje usługi i ceny prosto z Salonnare.
  • Partner integracyjny synchronizuje Twoją listę klientów.

Dostęp do API działa za pomocą klucza API: tajnego kodu, który potwierdza, że żądanie pochodzi od Ciebie. Traktuj ten klucz jak hasło.

Tworzenie klucza API

  1. Przejdź do Ustawienia -> API i webhooki.
  2. Na karcie Klucze API kliknij Nowy klucz.
  3. Nadaj kluczowi rozpoznawalną nazwę (na przykład "Księgowość") i wybierz uprawnienia: Tylko odczyt, Odczyt i zapis albo Pełny dostęp. W tej chwili klucz API może jedynie pobierać dane, niezależnie od wybranego poziomu uprawnień; klucz tylko do odczytu i tak nigdy nie zrobi nic więcej.
  4. Skopiuj klucz od razu i zapisz go w bezpiecznym miejscu. Z powodów bezpieczeństwa Salonnare pokazuje pełny klucz tylko raz.

Podejrzewasz, że klucz wyciekł? Usuń go natychmiast - każda integracja, która go używa, przestaje działać od razu.

Co to jest webhook?

Webhook to odwrotność API. Zamiast Ty pobierać dane, Salonnare automatycznie wysyła wiadomość na Twój adres (URL) w momencie, gdy coś się wydarzy. Inne oprogramowanie nie musi już samo dopytywać "czy jest coś nowego?" - sygnał dostaje samo.

Salonnare może wysyłać te sześć zdarzeń:

  • booking.created - pracownik tworzy wizytę w aplikacji
  • booking.updated - pracownik zmienia wizytę w aplikacji (również zmiana statusu na zakończona lub niestawienie się)
  • booking.cancelled - pracownik odwołuje wizytę w aplikacji
  • payment.received - pracownik kończy transakcję w kasie
  • client.created - pracownik tworzy klienta w aplikacji
  • client.updated - pracownik zmienia dane klienta w aplikacji
Tylko to, co dzieje się w aplikacji

Każde zdarzenie pochodzi z działania pracownika w aplikacji. Rezerwacja online przez Twoją stronę rezerwacji online lub Google, klient odwołujący wizytę samodzielnie, konwersja z listy rezerwowej, seria powtarzająca się, plan zabiegowy oraz klient tworzący się samodzielnie na stronie rezerwacji online jeszcze nie wysyłają powiadomienia. Wspomnij o tym swojemu partnerowi integracyjnemu: brakujące wizyty może wychwycić, pobierając okresowo listę wizyt.

Konfigurowanie webhooka

  1. Przejdź do Ustawienia -> API i webhooki i otwórz kartę Webhooki.
  2. Kliknij Nowy webhook.
  3. Wpisz URL, na który Salonnare powinno wysyłać powiadomienia (dostarczy go Twój partner integracyjny lub programista).
  4. Wybierz zdarzenia, na które chcesz reagować.
  5. Zapisz. Następnie możesz przeglądać logi dostaw, aby sprawdzić, czy powiadomienia docierają prawidłowo.

Sekret, którym Salonnare podpisuje wiadomości, wyświetla się w momencie zapisania webhooka - zapisz go od razu w bezpiecznym miejscu, tak jak klucz API, bo Salonnare już go więcej nie pokaże. Jeśli go zgubisz, kliknij ikonę odświeżania przy webhooku (Poproś o nowy sekret); zobaczysz wtedy nowy sekret jednorazowo. Stary sekret przestaje działać od tego momentu, więc stronę odbiorczą trzeba też zaktualizować.

Każde powiadomienie webhooka niesie podpis, za pomocą którego odbiorca może zweryfikować, że wiadomość naprawdę pochodzi od Salonnare.

Bezpieczna praca

  • Nigdy nie udostępniaj kluczy API publicznie (nie w e-mailu, na zrzutach ekranu ani w kodzie publikowanym online).
  • Dawaj integracji tylko te uprawnienia, których naprawdę potrzebuje - wybieraj tylko odczyt, gdy to możliwe.
  • Usuwaj klucze i webhooki, których już nie używasz.

Ponieważ Salonnare przetwarza Twoje dane w UE i Ty decydujesz, które integracje otrzymują dostęp, zachowujesz pełną kontrolę nad swoimi danymi. Potrzebujesz pomocy z integracją? Skontaktuj się ze Wsparciem przez stronę wsparcia.

Jesteś programistą i szukasz szczegółów technicznych (uwierzytelnianie, endpointy, pola, kody błędów, weryfikacja podpisu)? Zobacz Dokumentację API.

Powiązane artykuły

UstawieniaRezerwacje onlinePowiadomienia