API-Identitäten in Dalux FM API

Dieser Artikel erklärt, wie Sie API-Identitäten in FM einrichten.

Die Verwendung einer API-Identität ermöglicht einen detaillierten Zugriff auf die Dalux FM API, unter Verwendung bestehender Benutzerrollen und Regionslogik. Dadurch kann der API-Zugriff auf die notwendigen Daten beschränkt werden.

Wie man API-Identitäten einrichtet

Um eine API-Identität zu erstellen, gehen Sie zu:

Einstellungen Integrationen 'API-Identitäten':

Um eine neue API-Identität zu erstellen, klicken Sie Hinzufügen.

• Identitätstyp - Sie haben zwei Möglichkeiten
  • Allgemein - Direkter Zugriff auf Daten in der FM-Instanz
  • Firma - Externer Lieferanten-Zugriff auf Daten, wie in den Firmen-Einstellungen eingerichtet
• Name - Name der API-Identität (kann später geändert werden)
• E-Mail - E-Mail, die für die Kommunikation bezüglich der Dalux API-Dienste und der Verwendung der API-Identität verwendet wird (kann nicht geändert werden, sobald die API-Identität erstellt wurde)
• Administrator - Überschreibt die Berechtigungen jeder Benutzerrolle und gewährt Zugriff auf alle Daten. Für den 'Firma'-Identitätstyp gewährt es Zugriff als Firmenadministrator.
• Beschreibung - Eine optionale Beschreibung für die API-Identität, um Ihnen und anderen später zu helfen

Nachdem Sie die erforderlichen Informationen ausgefüllt und die Geschäftsbedingungen gelesen und akzeptiert haben, klicken Sie auf 'Einrichten', um mit der Einrichtung der API-Identität fortzufahren.

Sie können jetzt Benutzerrollen und Regionen zur API-Identität zuweisen. Diese bestimmen, welche Daten über die API zugänglich sind. Zum Beispiel können Sie nicht auf Arbeitsauftragsdaten zugreifen, wenn die zugewiesenen Benutzerrollen keinen Zugriff auf Arbeitsaufträge haben.

Wenn die API-Identität Administratorberechtigungen hat, überschreibt sie alle Berechtigungen in den Benutzerrollen und gewährt Zugriff auf alle Daten.

Um Benutzerrollen und Regionen zur API-Identität hinzuzufügen, klicken Sie im Bereich Benutzerrollen auf 'Hinzufügen'.

Sie können Benutzerrollen alleine hinzufügen oder auch eine Region für die Benutzerrolle angeben.

Sobald Sie Ihre Benutzerrollen hinzugefügt haben, können Sie beginnen, API-Schlüssel zu erstellen. Um API-Schlüssel für die API-Identität zu erstellen, klicken Sie im Bereich API-Schlüssel auf 'Hinzufügen'. Beim Erstellen eines API-Schlüssels müssen Sie die Ablaufzeit für den Schlüssel angeben.

Wenn Sie auf 'Hinzufügen' klicken, wird der API-Schlüssel generiert.

Kopieren Sie den Schlüssel und geben Sie ihn gemäß den Geschäftsbedingungen weiter. Die API-Identität kann ihren API-Schlüssel nun verwenden, beschränkt auf die API, die durch die Berechtigungen der Benutzerrolle festgelegt ist.