Użyj Uwierzytelniania OAuth, aby uzyskać dostęp do interfejsu API Bricsys 24/7

Przegląd

Aby zwiększyć bezpieczeństwo i zapewnić płynny dostęp do naszej platformy, wszystkie zewnętrzne aplikacje muszą uwierzytelniać się za pomocą OAuth.

W zależności od sposobu interakcji aplikacji z naszym systemem, należy użyć jednego z następujących przepływów OAuth:

  • Przepływ kodu autoryzacji: jeśli użytkownicy muszą się zalogować, aby uzyskać dostęp do własnych danych.
  • Client Credentials Flow: jeśli aplikacja działa niezależnie, bez interwencji użytkownika.

Ten przewodnik wyjaśnia, jak przejść na OAuth i informacje wymagane do zarejestrować swoją aplikację u naszego dostawcy tożsamości.

Korzystanie z przepływu kodu autoryzacji (dla dostępu opartego na użytkowniku)

Jeśli aplikacja wymaga od użytkowników uwierzytelniania i uzyskiwania dostępu do własnych danych, na stronie należy zaimplementować Authorization Code Flow.

Kroki do wdrożenia
  1. Przekieruj użytkowników do naszego serwera autoryzacji, aby poprosić o kod autoryzacyjny.
  2. Użytkownicy uwierzytelniają się przy użyciu swoich poświadczeń.
  3. Aplikacja wymienia kod autoryzacyjny na token dostępu.
  4. Token dostępu jest następnie używany do uzyskiwania dostępu do naszych interfejsów API w imieniu użytkownika.

Zobacz także dokumentację Authorization Code Flow.

Wymagane informacje do rejestracji klienta OAuth
Aby zarejestrować aplikację, należy podać następujące dane:
  • Nazwa aplikacji: dodaj unikalną nazwę, aby zidentyfikować aplikację.
  • Opis: dodaj opis korzystania przez aplikację z interfejsu API Bricsys 24/7.
  • Techniczna osoba kontaktowa: dodaj imię i nazwisko oraz adres e-mail.
  • Redirect URI(s): dodaj adresy URL, na które będą wysyłane odpowiedzi autoryzacji.

Korzystanie z przepływu poświadczeń klienta (dla dostępu maszyna-maszyna)

Jeśli aplikacja nie wymaga uwierzytelniania użytkownika i działa samodzielnie (na przykład usługi w tle, zautomatyzowane skrypty), użyj Client Credentials Flow.

Kroki do wdrożenia
  1. Aplikacja żąda tokena dostępu bezpośrednio z naszego serwera autoryzacji przy użyciu poświadczeń klienta.
  2. W przypadku pomyślnego uwierzytelnienia zwracany jest token dostępu.
  3. Token dostępu jest używany do interakcji z naszymi interfejsami API.

Zobacz także dokumentację Client Credentials Flow.

Wymagane informacje do rejestracji klienta OAuth
Aby zarejestrować aplikację, należy podać następujące dane:
  • Nazwa aplikacji: dodaj unikalny identyfikator aplikacji.
  • Opis: dodaj opis korzystania przez aplikację z interfejsu API Bricsys 24/7.
  • Techniczna osoba kontaktowa: dodaj imię i nazwisko oraz adres e-mail.
  • Nazwa konta usługi: dodaj adres e-mail konta Bricsys 24/7, którego zamierzasz używać jako konta usługi.
    Uwaga: Nie będzie możliwe zalogowanie się na stronie przy użyciu tego konta.

Ogólne zasoby OAuth

Aby lepiej zrozumieć OAuth i jego implementację, zapoznaj się z następującymi zasobami:

Następne kroki

  1. Wybierz odpowiedni przepływ OAuth w oparciu o potrzeby aplikacji.
  2. Zbierz wymagane dane rejestracyjne.
  3. Skontaktuj się z naszym zespołem pomocy technicznej za pośrednictwem Support Request, aby przesłać szczegóły aplikacji.
  4. Zaimplementuj przepływ uwierzytelniania w swojej aplikacji.

Jeśli potrzebujesz dalszej pomocy, wypełnij zgłoszenie do pomocy technicznej w aplikacji Bricsys 24/7 > API & integracja lub skontaktuj się bezpośrednio sales@bricsys247.com. Jesteśmy tutaj, aby pomóc!