Przejdź do głównej zawartości

Ustawienia API Live

Przegląd​

Syrve Live API lub Syrve Cloud API to usługa umożliwiająca interakcję komponentów Syrve między sobą lub z zewnętrznymi systemami. Użyj jej do integracji z Twoją stroną internetową i platformami dostaw jedzenia online (zamówienia będą wysyłane do POS) oraz do połączenia z aplikacją mobilną Driver.

Zamówienia dostawy składane za pośrednictwem Syrve Live API są dostępne tylko w Syrve 7.9.7 i nowszych.

 

Począwszy od wersji 7.0, możesz uzyskać dostęp do ustawień Syrve Live nie tylko w biurze internetowym, ale także w aplikacji back-office na pulpicie. W tym celu przejdź do Wymiana Danych > Ustawienia Syrve Live — strona ustawień Live API otworzy się w Twojej przeglądarce internetowej.

Aby uzyskać odniesienie do API, sprawdź Dokumentację Syrve Live API.

Licencjonowanie​

Wszystkie modele subskrypcji Syrve obejmują wszystkie możliwości integracji API Syrve Live.

Jak skonfigurować Syrve Live API​

Jak dodać nową integrację API​

Aby móc korzystać z usługi Syrve Live, musisz dodać Syrve Live Client: utwórz API Login i wygeneruj Klucz API używany w żądaniach.

W tym celu:

  1. Zaloguj się na swoje konto w biurze internetowym i otwórz aplikację Ustawienia Live API. Następnie przejdź do zakładki Integracje i kliknij Dodaj integrację.

     

    Jeśli otworzysz swoje biuro internetowe za pomocą aplikacji back-office na pulpicie, klikając element menu Wymiana Danych > Ustawienia Syrve Live, zostaniesz bezpośrednio przeniesiony do modułu Ustawienia Live API.

  2. Wprowadź API Login. Tutaj możesz określić, gdzie chcesz go używać — na swojej stronie internetowej, platformie dostaw jedzenia lub w aplikacji Driver.

    Klucz API zostanie wygenerowany automatycznie. Domyślnie będzie ważny przez dwa lata od bieżącej daty. Możesz określić dowolny okres ważności od dwóch dni do dwóch lat.

    Opcja Integracja jest aktywna zostanie włączona.

  3. Określ Email dla ważnych powiadomień o operacjach API (używane ograniczenia, planowane zmiany).

  4. Użyj pola Szablon uprawnień, aby określić rodzaj zamówień, które chcesz, aby zewnętrzna usługa obsługiwała: Uprawnienia do obsługi bankietów, Uprawnienia do obsługi dostaw, Uprawnienia do obsługi zamówień na miejscu lub Pełne Uprawnienia dla wszystkich wymienionych zamówień.

  5. Ustaw nazwę Źródła Zamówienia, jeśli potrzebujesz rozróżnić źródła i filtrować zamówienia według źródła. W przeciwnym razie możesz pozostawić to pole puste.

  6. Wybierz Menu Zewnętrzne, które utworzyłeś wcześniej. Jak utworzyć menu zewnętrzne, znajdziesz w artykule Ustawienia Menu Zewnętrznego. Jeśli pozostawisz to pole puste, dostępna będzie lista magazynowa określona w zewnętrznym menu aplikacji back-office na pulpicie.

  7. Określ Źródło ceny i Kategorie cen.

  8. Przejdź do zakładki Połączone Sklepy i dodaj restauracje, które używają tego klucza API: kliknij Dodaj lokalizację, zaznacz wymagane punkty i kliknij Dodaj.

  9. Skonfiguruj webhooki, jeśli to konieczne. W tym celu wybierz jeden lub więcej sklepów z listy i kliknij przycisk Ustawienia Webhooków (Grupowe ustawienia Webhooków dla więcej niż jednego sklepu). Określ URI i Token uwierzytelniający i kliknij Zastosuj. Użyj webhooków, aby uzyskać szczegóły dotyczące zamówienia i jego statusu.

  10. Kliknij Zapisz.

Teraz możesz użyć wygenerowanego klucza API w żądaniach lub wprowadzić go w aplikacji Driver. Aby skopiować klucz, kliknij .

Dla wersji Syrve 8.9 i wyższych klucz API zawiera 32 znaki i ma datę wygaśnięcia. Aby zaktualizować wcześniej utworzony klucz, kliknij Regeneruj i klucz zostanie automatycznie przedłużony o dwa lata od bieżącej daty. Dla wszystkich nowych kluczy API data wygaśnięcia jest wyświetlana na liście integracji.

Jak sprawdzić, czy Cloud API działa​

Gdy integracja zostanie utworzona, upewnij się, że usługa Syrve Live jest włączona:

  1. Będąc w aplikacji Ustawienia Live API, przejdź do zakładki Sklepy i wybierz sklep.

  2. Na zakładce Ogólne w sekcji Zapewnij dostęp do grup POS zaznacz wszystkie grupy terminali, które powinny działać przez Syrve Live API — zaznacz te grupy, gdzie zamówienia dostawy są przyjmowane w POS.

  3. Zapisz ustawienia.

Na liście Sklepy zwróć uwagę na następujące wskaźniki pokazujące dostępność urządzeń i statusy grup POS.

  • Dostępność serwera. Zielony wskaźnik naprzeciwko nazwy sklepu pokazuje, że serwer webowy Syrve działa poprawnie dla tego sklepu. Czerwona ikona informuje, że serwer jest niedostępny, a szara oznacza, że sklep nie jest połączony z Syrve Cloud API.
  • Dostępność urządzeń. Zielony wskaźnik oznacza, że sprzęt POS i aplikacja Syrve POS działają poprawnie. Czerwona ikona pokazuje, że sprzęt POS jest wyłączony.
  • Status grupy POS. Ikona pokazuje, że wtyczka transportowa działa poprawnie na POS. Czerwony wskaźnik oznacza, że wtyczka transportowa nie działa. Ikona pokazuje, że połączenie z grupą POS jest w stanie hibernacji.
  • Kombinacja ikon + pokazuje, że sprzęt POS działa poprawnie, ale wtyczka transportowa nie działa.

Ustawienia sklepu​

Niektóre ustawienia Live API mają zastosowanie natychmiast do wszystkich sklepów w sieci, na przykład praca z zamówieniami roboczymi w internetowym centrum obsługi. Aby umożliwić operowanie zamówieniami roboczymi, przejdź do zakładki Sklepy w Ustawieniach Live API, kliknij przycisk i włącz ustawienie Zezwól operatorom centrum obsługi na pracę z wersjami roboczymi zamówień.

Aby zmienić ustawienia połączenia Syrve Live dla jednego sklepu, przejdź do zakładki Sklepy w Ustawieniach Live API i kliknij nazwę punktu. Ustawienia są podane na kilku zakładkach.

Ustawienia ogólne​

  • Zezwól na eksport listy magazynowej do Live API — domyślnie włączone. Jeśli nie potrzebujesz eksportować listy magazynowej do Live API, wyłącz to ustawienie.

  • Zapewnij dostęp do grup POS. Określ, które sekcje sklepu (grupy POS) powinny działać przez Syrve Live, zaznaczając pole wyboru obok nazwy grupy.

    Aby sprawdzić szczegóły operacji na głównym terminalu POS lub określić, co powoduje błędy wtyczki Syrve Live (jeśli występują), kliknij przycisk Pobierz logi POS.

     

    Terminal POS sklepu musi być włączony, aby pobrać logi.

Wymiana Danych​

Zakładka Wymiana Danych wyświetla ostatni czas synchronizacji między usługami. Udane synchronizacje są oznaczone na zielono.

Ustawienia aplikacji kierowcy​

  • Nie pozwalaj na zmianę statusu zamówienia na "Dostarczone", jeśli nie znajdujesz się w lokalizacji dostawy. Jeśli zaznaczone, kierowca powinien znajdować się w dopuszczalnym promieniu, gdy oznacza zamówienie jako dostarczone. Jeśli kierowca znajduje się poza promieniem, nie będzie mógł oznaczyć zamówienia jako dostarczone.
  • Określ lokalizację dostawy z dokładnością do (m) — służy do ustawienia odległości od adresu dostawy, przy której kierowca może oznaczyć zamówienie jako dostarczone. Jest mierzona w metrach.
  • Pokaż timer na liście zamówień w aplikacji mobilnej. Jeśli włączone, aplikacja mobilna kierowcy pokaże timer odliczający do oczekiwanego czasu dostawy.

Czasami wszystkie licencje aplikacji kierowcy są zajęte, ale w rzeczywistości jeden z kierowców może zapomnieć wylogować się z aplikacji po zakończeniu swojej zmiany. W sekcji Licencje w użyciu wymienieni są wszyscy kierowcy aktualnie korzystający z aplikacji kierowcy.

Serwer lojalności POS​

Aby podłączyć kiosk samoobsługowy lub mobilną aplikację Syrve Waiter do POS za pomocą serwera lojalności POS, potrzebne będą loginy API.

Możesz wygenerować kilka loginów API dla jednego sklepu, ale ich ustawienia będą takie same dla wszystkich połączeń z serwerem lojalności POS. Aby wygenerować nowy login API, kliknij przycisk Dodaj i zapisz zmiany.

Konfiguracja​

  • Automatyczne drukowanie zamówień na miejscu. Jeśli Włączone, wszystkie zamówienia pochodzące z zintegrowanego rozwiązania będą automatycznie drukowane w kuchni. Jeśli ustawione na Zaufaj parametrom API, drukowanie biletu kuchennego będzie zależne od informacji o zamówieniu pochodzących z zewnętrznej integracji (parametr createOrderSettings —> servicePrint).

  • Edycja danych zewnętrznych. Możesz dodać zaawansowane ustawienia dla każdego sklepu jako pary klucz-wartość w formacie JSON. Aby to zrobić, kliknij Dodaj i wypełnij pola Klucz i Wartość. Zapisz zmiany.