Verwenden Sie die OAuth-Authentifizierung für den Zugriff auf die Bricsys 24/7 API

Übersicht

Um die Sicherheit zu erhöhen und einen nahtlosen Zugriff auf unsere Plattform zu gewährleisten, müssen sich alle externen Anwendungen mit OAuth authentifizieren.

Je nachdem, wie Ihre Anwendung mit unserem System interagiert, sollten Sie einen der folgenden OAuth-Workflows nutzen:

  • Autorisierungscode-Ablauf: Wenn Benutzer sich anmelden müssen, um auf ihre eigenen Daten zuzugreifen.
  • Ablauf für Client-Anmeldeinformationen: Wenn die Anwendung unabhängig und ohne Benutzereingriff agiert.

In diesem Leitfaden wird erklärt, wie Sie zu OAuth wechseln und welche Informationen Sie benötigen, um Ihre Anwendung bei unserem Identitätsanbieter zu registrieren.

Verwenden des Autorisierungscode-Ablaufs (für benutzerbasierten Zugriff)

Wenn Ihre Anwendung erfordert, dass sich Benutzer authentifizieren und auf ihre eigenen Daten zugreifen, müssen Sie den Autorisierungscode-Ablauf implementieren.

Schritte zur Implementierung
  1. Leiten Sie Benutzer zu unserem Autorisierungsserver weiter, um einen Autorisierungscode anzufordern.
  2. Benutzer authentifizieren sich mit ihren Anmeldeinformationen.
  3. Ihre Anwendung tauscht den Autorisierungscode gegen ein Zugriffstoken aus.
  4. Das Zugriffstoken wird dann verwendet, um im Namen des Benutzers auf unsere APIs zuzugreifen.

Weitere Informationen finden Sie in der Dokumentation zum Autorisierungscode-Ablauf.

Erforderliche Informationen für die Registrierung von OAuth-Clients
Geben Sie die folgenden Details an, um Ihre Anwendung zu registrieren:
  • Anwendungsname: Fügen Sie einen eindeutigen Namen hinzu, um Ihre Anwendung zu identifizieren.
  • Beschreibung: Fügen Sie eine Beschreibung der Art und Weise hinzu, wie Ihre Anwendung die Bricsys 24/7 API verwendet.
  • Technischer Ansprechpartner: Geben Sie einen Namen und eine E-Mail-Adresse ein.
  • URL(s) umleiten: Fügen Sie die URL(s) hinzu, an die Autorisierungsantworten gesendet werden.

Verwenden des Ablaufs von Client-Anmeldeinformationen (für den Zugriffstyp Gerät-zu-Gerät)

Wenn Ihre Anwendung keine Benutzerauthentifizierung erfordert und eigenständig handelt (z. B. Hintergrunddienste, automatisierte Skripts), verwenden Sie den Ablauf für Client-Anmeldeinformationen.

Schritte zur Implementierung
  1. Ihre Anwendung fordert ein Zugriffstoken direkt von unserem Autorisierungsserver mit ihren Client-Anmeldeinformationen an.
  2. Wenn die Authentifizierung erfolgreich ist, wird ein Zugriffstoken zurückgegeben.
  3. Das Zugriffstoken wird verwendet, um mit unseren APIs zu interagieren.

Weitere Informationen finden Sie in der Dokumentation zum Ablauf für Client-Anmeldeinformationen.

Erforderliche Informationen für die Registrierung von OAuth-Clients
Geben Sie die folgenden Details an, um Ihre Anwendung zu registrieren:
  • Anwendungsname: Fügen Sie einen eindeutigen Bezeichner für Ihre Anwendung hinzu.
  • Beschreibung: Fügen Sie eine Beschreibung der Art und Weise hinzu, wie Ihre Anwendung die Bricsys 24/7 API verwendet.
  • Technischer Ansprechpartner: Geben Sie einen Namen und eine E-Mail-Adresse ein.
  • Name des Dienstkontos: Fügen Sie die E-Mail-Adresse des Bricsys-24/7-Kontos hinzu, das Sie als Dienstkonto verwenden möchten.
    Anmerkung: Sie können sich mit diesem Konto nicht anmelden.

Allgemeine OAuth-Ressourcen

Weitere Informationen zu OAuth und seiner Implementierung finden Sie in den folgenden Ressourcen:

Nächste Schritte

  1. Wählen Sie den geeigneten OAuth-Ablauf basierend auf den Anforderungen Ihrer Anwendung aus.
  2. Sammeln Sie die erforderlichen Registrierungsdaten.
  3. Kontaktieren Sie unser Support-Team über eine Supportanfrage, um die Details Ihrer Anwendung einzureichen.
  4. Implementieren Sie den Authentifizierungsablauf in Ihrer Anwendung.

Wenn Sie weitere Hilfe benötigen, füllen Sie eine Supportanfrage in der Kategorie Bricsys 24/7 > API & Integration aus oder wenden Sie sich direkt an sales@bricsys247.com. Wir sind hier, um Ihnen zu helfen!