Wprowadzenie
Opis
Prosty API do Wstrzykiwania Zamówień (dalej SOI API) został zaprojektowany, aby szybko integrować Syrve z zewnętrznymi usługami zamówień dostawy, takimi jak strony internetowe restauracji, internetowi agregatorzy dostaw itp.
SOI API działa na bazie Syrve Live API i pozwala tworzyć zamówienia na dostawę i odbiór, używając prostszych struktur danych oraz WebHooków do śledzenia wszelkich zmian w zamówieniu, co znacznie upraszcza tworzenie gotowego rozwiązania.
Architektura SOI API może obsługiwać różne formaty przesyłania danych ze systemów zewnętrznych do Syrve i może być łatwo rozszerzana.
Przebieg pracy
Komponenty
Źródło zamówienia
Źródło zamówienia lub profil integracji jest tworzone w ramach konta Syrve App™ dla restauracji (lub sieci restauracji). W ramach konta można utworzyć kilka źródeł zamówień, w zależności od liczby obsługiwanych źródeł zewnętrznych.
Więcej informacji o tworzeniu profilu znajduje się w sekcji Konfiguracja źródła zamówienia.
Tworzenie zamówienia
Każde źródło zamówienia udostępnia unikalny endpoint do wstrzykiwania zamówień. System zewnętrzny musi przesłać zamówienie w określonym formacie. Szczegóły można znaleźć w sekcji Wstrzykiwanie zamówień.
Aktualizacje statusu zamówienia
Aby umożliwić otrzymywanie aktualizacji dotyczących bieżącego statusu zamówienia, w profilu integracji znajduje się specjalna właściwość z linkiem do odpowiedniego webhooka w systemie zewnętrznym („aktualizacja statusu zamówienia”).
Mapowanie menu
Większość nowoczesnych systemów używa uproszczonej struktury menu do tworzenia zamówień, gdzie każda pozycja menu jest osobnym rekordem z właściwościami takimi jak SKU/Nazwa/Cena. Aby zachować elastyczność wymaganą w branży restauracyjnej, poszczególne pozycje mogą być łączone w grupy modyfikatorów należące do głównego dania. Każdy modyfikator jest z kolei określony przez parametry SKU/Nazwa/Cena.
Aby nałożyć taką strukturę na strukturę menu w Syrve, która może używać rozmiarów pozycji, schematów modyfikatorów itd., SOI API oferuje dynamiczne możliwości mapowania, gdzie identyfikatory dań w systemie zewnętrznym mogą odpowiadać sekwencji identyfikatorów w Syrve, w tym, jeśli to konieczne, nazwie rozmiaru dania.
Aby uprościć tworzenie takiego mapowania, Syrve oferuje specjalny interfejs użytkownika z możliwością eksportu do formatu Excel. Więcej informacji o pracy z interfejsem znajduje się w sekcji Mapowanie menu.
Ceny
W zależności od ustawień Syrve Live API, kontrola cen dla zamówień tworzonych z systemów zewnętrznych może być aktywna lub nie. Jeśli kontrola cen jest włączona, a zamówienie otrzymane z systemu zewnętrznego zawiera cenę różną od ceny zdefiniowanej dla odpowiadającej pozycji w Syrve POS, takie zamówienie nie zostanie zaakceptowane przez system. Zaleca się wyłączenie kontroli cen. W takim przypadku, nawet jeśli cena pozycji w systemie zewnętrznym różni się od ceny w Syrve POS, zamówienie zostanie utworzone, a zastosowana zostanie cena pozycji z systemu zewnętrznego.